https://wiki.expertiza.ncsu.edu/api.php?action=feedcontributions&feedformat=atom&user=CshaoExpertiza_Wiki - User contributions [en]2026-08-23T06:37:50ZUser contributionsMediaWiki 1.41.0https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A6_Fix_account_creation_over_web_to_work_reasonably&diff=112669CSC/ECE 517 Fall 2017/E17A6 Fix account creation over web to work reasonably2017-11-08T04:26:41Z<p>Cshao: /* Use Cases */</p>
<hr />
<div>== '''Introduction to Expertiza''' ==<br />
Expertiza[https://expertiza.ncsu.edu/wiki/] is a project developed using Ruby on Rails[https://en.wikipedia.org/wiki/Ruby_on_Rails]. It provides features like peer review, team assignments and submission of projects. This can be achieved by submitting code base, URL of hosted code on remote server and Wiki submissions. It is an open source application and the code can be cloned from GitHub[https://en.wikipedia.org/wiki/GitHub]. This application provides an efficient way to manage assignments, grades and reviews. This makes the process easier and faster when the class strength is large.<br />
== '''Introduction''' ==<br />
=== '''Purpose''' ===<br />
Expertiza provide the function for user to request an account, but the function is not perfect. The goal of our project is to improve this feature. It will enable Expertiza to handle the pending request for super-admin and add institution for user.<br />
<br />
=== '''Problem Definition''' ===<br />
===='''New user request page'''====<br />
*Currently, a new user can only choose institution from the dropdown. The new user should be able to add a new institution. <br />
*A place where a new user to write a brief introduction is needed in this page.<br />
*Also, in models/requested_user.rb, there are some validations, such as validate email address. It will be better to update the flash message on the view when validation fails.<br />
===='''Super-admin and admin are able to approve or decline new user requests. '''====<br />
*Currently, you have to go to /users/list_pending_requested this url to access a list of pending requests. It will be better to add an option in “Administration > Show…” menu <br />
*Make “Email Address” column in /users/list_pending_requested page clickable. So that super-admin or admin could converse with requesters by clicking email addresses directly.<br />
===='''After approving'''====<br />
*After super-admin or admin approves the request, make sure the record does not disappear on the page. And there should be an email send to email address offered by requester.<br />
<br />
== '''Requirements''' ==<br />
*Modify the test of request new user method. <br />
*Add a new option for the drop-down bar of institution in the new user request page.<br />
*Add a new textarea in the new user request page, to input a new institution and introduction.<br />
*Add validation for new institution new institutions and introductions.<br />
*Add flash message for requested_user.rb.<br />
*Add a new button on the layout.<br />
*Modify the layout of /users/list_pending_requested page.<br />
*Enable the system will send an email after the request is processed.<br />
<br />
=='''Database Design'''==<br />
[[File:17a61.JPG]]<br />
*The above tables is the original table for this project, however it lacks a column for introduction. So we need to add a new column for request_user table. The new table will be shown below.<br />
[[File:17a62.JPG]]<br />
<br />
=='''Use Cases'''==<br />
[[File:Expertiza_Use_Case_for_New_Account_Request.png]]<br />
<br />
[[File:17a6e.JPG]]<br />
*Name: Instructor or Teaching Assistant request a new account<br />
*Actor: Instructor or Teaching Assistant<br />
*Other Participants: None<br />
*Precondition: None<br />
*Primary Sequence:<br />
::1. Click on “Request account”.<br />
::2. Select a role.<br />
::3. Fill in a user name.<br />
::4. Fill in a full name.<br />
::5. Fill in an email address.<br />
::6. Select an institution.<br />
::7. Fill in the introduction field.<br />
::8. Click on “Request”.<br />
*Alternative Flow:<br />
::1. If the institution not in the list, click on “Others”.<br />
::2. Fill in the institution name.<br />
<br />
<br />
*Name: Admin or Super admin view list of new account requests<br />
*Actor: Admin or Super admin<br />
*Other Participants: None<br />
*Precondition: Instructor or Teaching Assistant has requested a new account<br />
*Primary Sequence:<br />
::1. Log in to Expertiza.<br />
::2. Click on the link “/users/list_pending_requested”.<br />
::3. View the list of new account requests.<br />
*Alternative Flow: None<br />
<br />
<br />
*Name: Admin or Super admin accept a new account request<br />
*Actor: Admin or Super admin<br />
*Other Participants: None<br />
*Precondition: Instructor or Teaching Assistant has requested a new account<br />
*Primary Sequence:<br />
::1. Log in to Expertiza.<br />
::2. Click on the link “/users/list_pending_requested”.<br />
::3. Select a request.<br />
::4. Click on “Accept”.<br />
::5. Click on “Submit”.<br />
*Alternative Flow: None<br />
<br />
<br />
*Name: Admin or Super admin reject a new account request<br />
*Actor: Admin or Super admin<br />
*Other Participants: None<br />
*Precondition: Instructor or Teaching Assistant has requested a new account<br />
*Primary Sequence:<br />
::1. Log in to Expertiza<br />
::2. Click on the link “/users/list_pending_requested”.<br />
::3. Select a request.<br />
::4. Click on “Reject”.<br />
::5. Click on “Submit”.<br />
*Alternative Flow: None<br />
<br />
<br />
*Name: Admin or Super admin send an email to applicant<br />
*Actor: Admin or Super admin<br />
*Other Participants: None<br />
*Precondition: Instructor or Teaching Assistant has requested a new account<br />
*Primary Sequence:<br />
::1. Log in to Expertiza<br />
::2. Click on the link “/users/list_pending_requested”.<br />
::3. Select a request.<br />
::4. Click on the email address.<br />
::5. Write the email.<br />
*Alternative Flow: None<br />
<br />
=='''Design Pattern'''==<br />
==='''MVC'''===<br />
The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).<br />
<br />
==='''TDD'''===<br />
In this project, we follow the Test-driven development (TDD) software development process, which means that we would first write a test that fails before you write new functional code.<br />
<br />
==='''DIY'''===<br />
We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.<br />
<br />
=='''Mockup Screen'''==<br />
Below are the mock-up screens that explain “new account acreation” functionality in Expertiza. <br />
*1.New user should click “request account” for requesting a new account, then redirect to the “request new ” page.<br />
[[File:17a65.jpg]]<br />
*2.After redirect to “request new ” page, new users should enter their information, includes role, name, e-mail and institution. If the institution that new users want to choose is not in the list, we can choose “others” option, then a textbox will appear. We can enter our new institution in this textbox. Finally, we can click “request” button to submit our request, and wait for being approved by administrator. <br />
[[File:17a66.jpg]]<br />
*3. If we login as administrator, we can see the screens below.<br />
[[File:17a67.jpg]]<br />
*4. If we click “show requests”, we can see this screen. The email address is clickable.<br />
[[File:17a68.jpg]]<br />
*5.If we click the email address, the email editor will pop out. Administrator can converse with requestor directly.<br />
[[File:17a6a.jpg]]</div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=File:Expertiza_Use_Case_for_New_Account_Request.png&diff=112668File:Expertiza Use Case for New Account Request.png2017-11-08T04:25:36Z<p>Cshao: </p>
<hr />
<div></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A6_Fix_account_creation_over_web_to_work_reasonably&diff=112661CSC/ECE 517 Fall 2017/E17A6 Fix account creation over web to work reasonably2017-11-08T04:19:38Z<p>Cshao: /* Use Cases */</p>
<hr />
<div>== '''Introduction to Expertiza''' ==<br />
Expertiza[https://expertiza.ncsu.edu/wiki/] is a project developed using Ruby on Rails[https://en.wikipedia.org/wiki/Ruby_on_Rails]. It provides features like peer review, team assignments and submission of projects. This can be achieved by submitting code base, URL of hosted code on remote server and Wiki submissions. It is an open source application and the code can be cloned from GitHub[https://en.wikipedia.org/wiki/GitHub]. This application provides an efficient way to manage assignments, grades and reviews. This makes the process easier and faster when the class strength is large.<br />
== '''Introduction''' ==<br />
=== '''Purpose''' ===<br />
Expertiza provide the function for user to request an account, but the function is not perfect. The goal of our project is to improve this feature. It will enable Expertiza to handle the pending request for super-admin and add institution for user.<br />
<br />
=== '''Problem Definition''' ===<br />
===='''New user request page'''====<br />
*Currently, a new user can only choose institution from the dropdown. The new user should be able to add a new institution. <br />
*A place where a new user to write a brief introduction is needed in this page.<br />
*Also, in models/requested_user.rb, there are some validations, such as validate email address. It will be better to update the flash message on the view when validation fails.<br />
===='''Super-admin and admin are able to approve or decline new user requests. '''====<br />
*Currently, you have to go to /users/list_pending_requested this url to access a list of pending requests. It will be better to add an option in “Administration > Show…” menu <br />
*Make “Email Address” column in /users/list_pending_requested page clickable. So that super-admin or admin could converse with requesters by clicking email addresses directly.<br />
===='''After approving'''====<br />
*After super-admin or admin approves the request, make sure the record does not disappear on the page. And there should be an email send to email address offered by requester.<br />
<br />
== '''Requirements''' ==<br />
*Modify the test of request new user method. <br />
*Add a new option for the drop-down bar of institution in the new user request page.<br />
*Add a new textarea in the new user request page, to input a new institution and introduction.<br />
*Add validation for new institution new institutions and introductions.<br />
*Add flash message for requested_user.rb.<br />
*Add a new button on the layout.<br />
*Modify the layout of /users/list_pending_requested page.<br />
*Enable the system will send an email after the request is processed.<br />
<br />
=='''Database Design'''==<br />
[[File:17a61.JPG]]<br />
*The above tables is the original table for this project, however it lacks a column for introduction. So we need to add a new column for request_user table. The new table will be shown below.<br />
[[File:17a62.JPG]]<br />
<br />
=='''Use Cases'''==<br />
[[File:17a6b.jpg]]<br />
<br />
[[File:17a6e.JPG]]<br />
*Name: Instructor or Teaching Assistant request a new account<br />
*Actor: Instructor or Teaching Assistant<br />
*Other Participants: None<br />
*Precondition: None<br />
*Primary Sequence:<br />
::1. Click on “Request account”.<br />
::2. Select a role.<br />
::3. Fill in a user name.<br />
::4. Fill in a full name.<br />
::5. Fill in an email address.<br />
::6. Select an institution.<br />
::7. Fill in the introduction field.<br />
::8. Click on “Request”.<br />
*Alternative Flow:<br />
::1. If the institution not in the list, click on “Others”.<br />
::2. Fill in the institution name.<br />
<br />
<br />
*Name: Admin or Super admin view list of new account requests<br />
*Actor: Admin or Super admin<br />
*Other Participants: None<br />
*Precondition: Instructor or Teaching Assistant has requested a new account<br />
*Primary Sequence:<br />
::1. Log in to Expertiza.<br />
::2. Click on the link “/users/list_pending_requested”.<br />
::3. View the list of new account requests.<br />
*Alternative Flow: None<br />
<br />
<br />
*Name: Admin or Super admin accept a new account request<br />
*Actor: Admin or Super admin<br />
*Other Participants: None<br />
*Precondition: Instructor or Teaching Assistant has requested a new account<br />
*Primary Sequence:<br />
::1. Log in to Expertiza.<br />
::2. Click on the link “/users/list_pending_requested”.<br />
::3. Select a request.<br />
::4. Click on “Accept”.<br />
::5. Click on “Submit”.<br />
*Alternative Flow: None<br />
<br />
<br />
*Name: Admin or Super admin reject a new account request<br />
*Actor: Admin or Super admin<br />
*Other Participants: None<br />
*Precondition: Instructor or Teaching Assistant has requested a new account<br />
*Primary Sequence:<br />
::1. Log in to Expertiza<br />
::2. Click on the link “/users/list_pending_requested”.<br />
::3. Select a request.<br />
::4. Click on “Reject”.<br />
::5. Click on “Submit”.<br />
*Alternative Flow: None<br />
<br />
<br />
*Name: Admin or Super admin send an email to applicant<br />
*Actor: Admin or Super admin<br />
*Other Participants: None<br />
*Precondition: Instructor or Teaching Assistant has requested a new account<br />
*Primary Sequence:<br />
::1. Log in to Expertiza<br />
::2. Click on the link “/users/list_pending_requested”.<br />
::3. Select a request.<br />
::4. Click on the email address.<br />
::5. Write the email.<br />
*Alternative Flow: None<br />
<br />
=='''Design Pattern'''==<br />
==='''MVC'''===<br />
The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).<br />
<br />
==='''TDD'''===<br />
In this project, we follow the Test-driven development (TDD) software development process, which means that we would first write a test that fails before you write new functional code.<br />
<br />
==='''DIY'''===<br />
We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.<br />
<br />
=='''Mockup Screen'''==<br />
Below are the mock-up screens that explain “new account acreation” functionality in Expertiza. <br />
*1.New user should click “request account” for requesting a new account, then redirect to the “request new ” page.<br />
[[File:17a65.jpg]]<br />
*2.After redirect to “request new ” page, new users should enter their information, includes role, name, e-mail and institution. If the institution that new users want to choose is not in the list, we can choose “others” option, then a textbox will appear. We can enter our new institution in this textbox. Finally, we can click “request” button to submit our request, and wait for being approved by administrator. <br />
[[File:17a66.jpg]]<br />
*3. If we login as administrator, we can see the screens below.<br />
[[File:17a67.jpg]]<br />
*4. If we click “show requests”, we can see this screen. The email address is clickable.<br />
[[File:17a68.jpg]]<br />
*5.If we click the email address, the email editor will pop out. Administrator can converse with requestor directly.<br />
[[File:17a6a.jpg]]</div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A6_Fix_account_creation_over_web_to_work_reasonably&diff=112116CSC/ECE 517 Fall 2017/E17A6 Fix account creation over web to work reasonably2017-11-07T02:11:31Z<p>Cshao: /* Use Cases */</p>
<hr />
<div>== '''Introduction to Expertiza''' ==<br />
Expertiza[https://expertiza.ncsu.edu/wiki/] is a project developed using Ruby on Rails[https://en.wikipedia.org/wiki/Ruby_on_Rails]. It provides features like peer review, team assignments and submission of projects. This can be achieved by submitting code base, URL of hosted code on remote server and Wiki submissions. It is an open source application and the code can be cloned from GitHub[https://en.wikipedia.org/wiki/GitHub]. This application provides an efficient way to manage assignments, grades and reviews. This makes the process easier and faster when the class strength is large.<br />
== '''Introduction''' ==<br />
=== '''Purpose''' ===<br />
Expertiza provide the function for user to request an account, but the function is not perfect. The goal of our project is to improve this feature. It will enable Expertiza to handle the pending request for super-admin and add institution for user.<br />
<br />
=== '''Problem Definition''' ===<br />
===='''New user request page'''====<br />
*Currently, a new user can only choose institution from the dropdown. The new user should be able to add a new institution. <br />
*A place where a new user to write a brief introduction is needed in this page.<br />
*Also, in models/requested_user.rb, there are some validations, such as validate email address. It will be better to update the flash message on the view when validation fails.<br />
===='''Super-admin and admin are able to approve or decline new user requests. '''====<br />
*Currently, you have to go to /users/list_pending_requested this url to access a list of pending requests. It will be better to add an option in “Administration > Show…” menu <br />
*Make “Email Address” column in /users/list_pending_requested page clickable. So that super-admin or admin could converse with requesters by clicking email addresses directly.<br />
===='''After approving'''====<br />
*After super-admin or admin approves the request, make sure the record does not disappear on the page. And there should be an email send to email address offered by requester.<br />
<br />
== '''Requirements''' ==<br />
*Modify the test of request new user method. <br />
*Add a new option for the drop-down bar of institution in the new user request page.<br />
*Add a new textarea in the new user request page, to input a new institution and introduction.<br />
*Add validation for new institution new institutions and introductions.<br />
*Add flash message for requested_user.rb.<br />
*Add a new button on the layout.<br />
*Modify the layout of /users/list_pending_requested page.<br />
*Enable the system will send an email after the request is processed.<br />
<br />
=='''Database Design'''==<br />
[[File:17a61.JPG]]<br />
*The above tables is the original table for this project, however it lacks a column for introduction. So we need to add a new column for request_user table. The new table will be shown below.<br />
[[File:17a62.JPG]]<br />
<br />
=='''Use Cases'''==<br />
[[File:17a63.jpg]]<br />
*Name: Instructor or Teaching Assistant request a new account<br />
*Actor: Instructor or Teaching Assistant<br />
*Other Participants: None<br />
*Precondition: None<br />
*Primary Sequence:<br />
::1. Click on “Request account”.<br />
::2. Select a role.<br />
::3. Fill in a user name.<br />
::4. Fill in a full name.<br />
::5. Fill in an email address.<br />
::6. Select an institution.<br />
::7. Fill in the introduction field.<br />
::8. Click on “Request”.<br />
*Alternative Flow:<br />
::6.1 If the institution not in the list, click on “Others”.<br />
::6.2 Fill in the institution name.<br />
<br />
<br />
*Name: Admin or Super admin view list of new account requests<br />
*Actor: Admin or Super admin<br />
*Other Participants: None<br />
*Precondition: Instructor or Teaching Assistant has requested a new account<br />
*Primary Sequence:<br />
::1. Log in to Expertiza.<br />
::2. Click on the link “/users/list_pending_requested”.<br />
::3. View the list of new account requests.<br />
*Alternative Flow: None<br />
<br />
<br />
*Name: Admin or Super admin accept a new account request<br />
*Actor: Admin or Super admin<br />
*Other Participants: None<br />
*Precondition: Instructor or Teaching Assistant has requested a new account<br />
*Primary Sequence:<br />
::1. Log in to Expertiza.<br />
::2. Click on the link “/users/list_pending_requested”.<br />
::3. Select a request.<br />
::4. Click on “Accept”.<br />
::5. Click on “Submit”.<br />
*Alternative Flow: None<br />
<br />
<br />
*Name: Admin or Super admin reject a new account request<br />
*Actor: Admin or Super admin<br />
*Other Participants: None<br />
*Precondition: Instructor or Teaching Assistant has requested a new account<br />
*Primary Sequence:<br />
::1. Log in to Expertiza<br />
::2. Click on the link “/users/list_pending_requested”.<br />
::3. Select a request.<br />
::4. Click on “Reject”.<br />
::5. Click on “Submit”.<br />
*Alternative Flow: None<br />
<br />
<br />
*Name: Admin or Super admin send an email to applicant<br />
*Actor: Admin or Super admin<br />
*Other Participants: None<br />
*Precondition: Instructor or Teaching Assistant has requested a new account<br />
*Primary Sequence:<br />
::1. Log in to Expertiza<br />
::2. Click on the link “/users/list_pending_requested”.<br />
::3. Select a request.<br />
::4. Click on the email address.<br />
::5. Write the email.<br />
*Alternative Flow: None<br />
<br />
=='''Design Pattern'''==<br />
==='''MVC'''===<br />
The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).<br />
<br />
==='''TDD'''===<br />
In this project, we follow the Test-driven development (TDD) software development process, which means that we would first write a test that fails before you write new functional code.<br />
<br />
==='''DIY'''===<br />
We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.<br />
<br />
=='''Mockup Screen'''==<br />
Below are the mock-up screens that explain “new account acreation” functionality in Expertiza. <br />
*1.New user should click “request account” for requesting a new account, then redirect to the “request new ” page.<br />
[[File:17a65.jpg]]<br />
*2.After redirect to “request new ” page, new users should enter their information, includes role, name, e-mail and institution. If the institution that new users want to choose is not in the list, we can choose “others” option, then a textbox will appear. We can enter our new institution in this textbox. Finally, we can click “request” button to submit our request, and wait for being approved by administrator. <br />
[[File:17a66.jpg]]<br />
*3. If we login as administrator, we can see the screens below.<br />
[[File:17a67.jpg]]<br />
*4. If we click “show requests”, we can see this screen. The email address is clickable.<br />
[[File:17a68.jpg]]<br />
*5.If we click the email address, the email editor will pop out. Administrator can converse with requestor directly.<br />
[[File:17a6a.jpg]]</div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A6_Fix_account_creation_over_web_to_work_reasonably&diff=112115CSC/ECE 517 Fall 2017/E17A6 Fix account creation over web to work reasonably2017-11-07T02:11:00Z<p>Cshao: /* Use Cases */</p>
<hr />
<div>== '''Introduction to Expertiza''' ==<br />
Expertiza[https://expertiza.ncsu.edu/wiki/] is a project developed using Ruby on Rails[https://en.wikipedia.org/wiki/Ruby_on_Rails]. It provides features like peer review, team assignments and submission of projects. This can be achieved by submitting code base, URL of hosted code on remote server and Wiki submissions. It is an open source application and the code can be cloned from GitHub[https://en.wikipedia.org/wiki/GitHub]. This application provides an efficient way to manage assignments, grades and reviews. This makes the process easier and faster when the class strength is large.<br />
== '''Introduction''' ==<br />
=== '''Purpose''' ===<br />
Expertiza provide the function for user to request an account, but the function is not perfect. The goal of our project is to improve this feature. It will enable Expertiza to handle the pending request for super-admin and add institution for user.<br />
<br />
=== '''Problem Definition''' ===<br />
===='''New user request page'''====<br />
*Currently, a new user can only choose institution from the dropdown. The new user should be able to add a new institution. <br />
*A place where a new user to write a brief introduction is needed in this page.<br />
*Also, in models/requested_user.rb, there are some validations, such as validate email address. It will be better to update the flash message on the view when validation fails.<br />
===='''Super-admin and admin are able to approve or decline new user requests. '''====<br />
*Currently, you have to go to /users/list_pending_requested this url to access a list of pending requests. It will be better to add an option in “Administration > Show…” menu <br />
*Make “Email Address” column in /users/list_pending_requested page clickable. So that super-admin or admin could converse with requesters by clicking email addresses directly.<br />
===='''After approving'''====<br />
*After super-admin or admin approves the request, make sure the record does not disappear on the page. And there should be an email send to email address offered by requester.<br />
<br />
== '''Requirements''' ==<br />
*Modify the test of request new user method. <br />
*Add a new option for the drop-down bar of institution in the new user request page.<br />
*Add a new textarea in the new user request page, to input a new institution and introduction.<br />
*Add validation for new institution new institutions and introductions.<br />
*Add flash message for requested_user.rb.<br />
*Add a new button on the layout.<br />
*Modify the layout of /users/list_pending_requested page.<br />
*Enable the system will send an email after the request is processed.<br />
<br />
=='''Database Design'''==<br />
[[File:17a61.JPG]]<br />
*The above tables is the original table for this project, however it lacks a column for introduction. So we need to add a new column for request_user table. The new table will be shown below.<br />
[[File:17a62.JPG]]<br />
<br />
=='''Use Cases'''==<br />
[[File:17a63.jpg]]<br />
*Name: Instructor or Teaching Assistant request a new account<br />
*Actor: Instructor or Teaching Assistant<br />
*Other Participants: None<br />
*Precondition: None<br />
*Primary Sequence:<br />
::1. Click on “Request account”.<br />
::2. Select a role.<br />
::3. Fill in a user name.<br />
::4. Fill in a full name.<br />
::5. Fill in an email address.<br />
::6. Select an institution.<br />
::7. Fill in the introduction field.<br />
::8. Click on “Request”.<br />
*Alternative Flow:<br />
::6.1. If the institution not in the list, click on “Others”.<br />
::6.2. Fill in the institution name.<br />
<br />
<br />
*Name: Admin or Super admin view list of new account requests<br />
*Actor: Admin or Super admin<br />
*Other Participants: None<br />
*Precondition: Instructor or Teaching Assistant has requested a new account<br />
*Primary Sequence:<br />
::1. Log in to Expertiza.<br />
::2. Click on the link “/users/list_pending_requested”.<br />
::3. View the list of new account requests.<br />
*Alternative Flow: None<br />
<br />
<br />
*Name: Admin or Super admin accept a new account request<br />
*Actor: Admin or Super admin<br />
*Other Participants: None<br />
*Precondition: Instructor or Teaching Assistant has requested a new account<br />
*Primary Sequence:<br />
::1. Log in to Expertiza.<br />
::2. Click on the link “/users/list_pending_requested”.<br />
::3. Select a request.<br />
::4. Click on “Accept”.<br />
::5. Click on “Submit”.<br />
*Alternative Flow: None<br />
<br />
<br />
*Name: Admin or Super admin reject a new account request<br />
*Actor: Admin or Super admin<br />
*Other Participants: None<br />
*Precondition: Instructor or Teaching Assistant has requested a new account<br />
*Primary Sequence:<br />
::1. Log in to Expertiza<br />
::2. Click on the link “/users/list_pending_requested”.<br />
::3. Select a request.<br />
::4. Click on “Reject”.<br />
::5. Click on “Submit”.<br />
*Alternative Flow: None<br />
<br />
<br />
*Name: Admin or Super admin send an email to applicant<br />
*Actor: Admin or Super admin<br />
*Other Participants: None<br />
*Precondition: Instructor or Teaching Assistant has requested a new account<br />
*Primary Sequence:<br />
::1. Log in to Expertiza<br />
::2. Click on the link “/users/list_pending_requested”.<br />
::3. Select a request.<br />
::4. Click on the email address.<br />
::5. Write the email.<br />
*Alternative Flow: None<br />
<br />
=='''Design Pattern'''==<br />
==='''MVC'''===<br />
The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).<br />
<br />
==='''TDD'''===<br />
In this project, we follow the Test-driven development (TDD) software development process, which means that we would first write a test that fails before you write new functional code.<br />
<br />
==='''DIY'''===<br />
We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.<br />
<br />
=='''Mockup Screen'''==<br />
Below are the mock-up screens that explain “new account acreation” functionality in Expertiza. <br />
*1.New user should click “request account” for requesting a new account, then redirect to the “request new ” page.<br />
[[File:17a65.jpg]]<br />
*2.After redirect to “request new ” page, new users should enter their information, includes role, name, e-mail and institution. If the institution that new users want to choose is not in the list, we can choose “others” option, then a textbox will appear. We can enter our new institution in this textbox. Finally, we can click “request” button to submit our request, and wait for being approved by administrator. <br />
[[File:17a66.jpg]]<br />
*3. If we login as administrator, we can see the screens below.<br />
[[File:17a67.jpg]]<br />
*4. If we click “show requests”, we can see this screen. The email address is clickable.<br />
[[File:17a68.jpg]]<br />
*5.If we click the email address, the email editor will pop out. Administrator can converse with requestor directly.<br />
[[File:17a6a.jpg]]</div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A6_Fix_account_creation_over_web_to_work_reasonably&diff=112113CSC/ECE 517 Fall 2017/E17A6 Fix account creation over web to work reasonably2017-11-07T02:08:40Z<p>Cshao: /* Use Cases */</p>
<hr />
<div>== '''Introduction to Expertiza''' ==<br />
Expertiza[https://expertiza.ncsu.edu/wiki/] is a project developed using Ruby on Rails[https://en.wikipedia.org/wiki/Ruby_on_Rails]. It provides features like peer review, team assignments and submission of projects. This can be achieved by submitting code base, URL of hosted code on remote server and Wiki submissions. It is an open source application and the code can be cloned from GitHub[https://en.wikipedia.org/wiki/GitHub]. This application provides an efficient way to manage assignments, grades and reviews. This makes the process easier and faster when the class strength is large.<br />
== '''Introduction''' ==<br />
=== '''Purpose''' ===<br />
Expertiza provide the function for user to request an account, but the function is not perfect. The goal of our project is to improve this feature. It will enable Expertiza to handle the pending request for super-admin and add institution for user.<br />
<br />
=== '''Problem Definition''' ===<br />
===='''New user request page'''====<br />
*Currently, a new user can only choose institution from the dropdown. The new user should be able to add a new institution. <br />
*A place where a new user to write a brief introduction is needed in this page.<br />
*Also, in models/requested_user.rb, there are some validations, such as validate email address. It will be better to update the flash message on the view when validation fails.<br />
===='''Super-admin and admin are able to approve or decline new user requests. '''====<br />
*Currently, you have to go to /users/list_pending_requested this url to access a list of pending requests. It will be better to add an option in “Administration > Show…” menu <br />
*Make “Email Address” column in /users/list_pending_requested page clickable. So that super-admin or admin could converse with requesters by clicking email addresses directly.<br />
===='''After approving'''====<br />
*After super-admin or admin approves the request, make sure the record does not disappear on the page. And there should be an email send to email address offered by requester.<br />
<br />
== '''Requirements''' ==<br />
*Modify the test of request new user method. <br />
*Add a new option for the drop-down bar of institution in the new user request page.<br />
*Add a new textarea in the new user request page, to input a new institution and introduction.<br />
*Add validation for new institution new institutions and introductions.<br />
*Add flash message for requested_user.rb.<br />
*Add a new button on the layout.<br />
*Modify the layout of /users/list_pending_requested page.<br />
*Enable the system will send an email after the request is processed.<br />
<br />
=='''Database Design'''==<br />
[[File:17a61.JPG]]<br />
*The above tables is the original table for this project, however it lacks a column for introduction. So we need to add a new column for request_user table. The new table will be shown below.<br />
[[File:17a62.JPG]]<br />
<br />
=='''Use Cases'''==<br />
[[File:17a63.jpg]]<br />
*Name: Instructor or Teaching Assistant request a new account<br />
*Actor: Instructor or Teaching Assistant<br />
*Other Participants: None<br />
*Precondition: None<br />
*Primary Sequence:<br />
::1.Click on “Request account”.<br />
::2.Select a role.<br />
::3.Fill in a user name.<br />
::4.Fill in a full name.<br />
::5.Fill in an email address.<br />
::6.Select an institution.<br />
::7.Fill in the introduction field.<br />
::8.Click on “Request”.<br />
*Alternative Flow:<br />
::6.1.If the institution not in the list, click on “Others”.<br />
::6.2.Fill in the institution name.<br />
<br />
<br />
*Name: Admin or Super admin view list of new account requests<br />
*Actor: Admin or Super admin<br />
*Other Participants: None<br />
*Precondition: Instructor or Teaching Assistant has requested a new account<br />
*Primary Sequence:<br />
::1.Log in to Expertiza.<br />
::2.Click on the link “/users/list_pending_requested”.<br />
::3.View the list of new account requests.<br />
*Alternative Flow: None<br />
<br />
<br />
*Name: Admin or Super admin accept a new account request<br />
*Actor: Admin or Super admin<br />
*Other Participants: None<br />
*Precondition: Instructor or Teaching Assistant has requested a new account<br />
*Primary Sequence:<br />
::1.Log in to Expertiza.<br />
::2.Click on the link “/users/list_pending_requested”.<br />
::3.Select a request.<br />
::4.Click on “Accept”.<br />
::5.Click on “Submit”.<br />
*Alternative Flow: None<br />
<br />
<br />
*Name: Admin or Super admin reject a new account request<br />
*Actor: Admin or Super admin<br />
*Other Participants: None<br />
*Precondition: Instructor or Teaching Assistant has requested a new account<br />
*Primary Sequence:<br />
::1.Log in to Expertiza<br />
::2.Click on the link “/users/list_pending_requested”.<br />
::3.Select a request.<br />
::4.Click on “Reject”.<br />
::5.Click on “Submit”.<br />
*Alternative Flow: None<br />
<br />
<br />
*Name: Admin or Super admin send an email to applicant<br />
*Actor: Admin or Super admin<br />
*Other Participants: None<br />
*Precondition: Instructor or Teaching Assistant has requested a new account<br />
*Primary Sequence:<br />
::1.Log in to Expertiza<br />
::2.Click on the link “/users/list_pending_requested”.<br />
::3.Select a request.<br />
::4.Click on the email address.<br />
::5.Write the email.<br />
*Alternative Flow: None<br />
<br />
=='''Design Pattern'''==<br />
==='''MVC'''===<br />
The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).<br />
<br />
==='''TDD'''===<br />
In this project, we follow the Test-driven development (TDD) software development process, which means that we would first write a test that fails before you write new functional code.<br />
<br />
==='''DIY'''===<br />
We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.<br />
<br />
=='''Mockup Screen'''==<br />
Below are the mock-up screens that explain “new account acreation” functionality in Expertiza. <br />
*1.New user should click “request account” for requesting a new account, then redirect to the “request new ” page.<br />
[[File:17a65.jpg]]<br />
*2.After redirect to “request new ” page, new users should enter their information, includes role, name, e-mail and institution. If the institution that new users want to choose is not in the list, we can choose “others” option, then a textbox will appear. We can enter our new institution in this textbox. Finally, we can click “request” button to submit our request, and wait for being approved by administrator. <br />
[[File:17a66.jpg]]<br />
*3. If we login as administrator, we can see the screens below.<br />
[[File:17a67.jpg]]<br />
*4. If we click “show requests”, we can see this screen. The email address is clickable.<br />
[[File:17a68.jpg]]<br />
*5.If we click the email address, the email editor will pop out. Administrator can converse with requestor directly.<br />
[[File:17a6a.jpg]]</div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E17A6_Fix_account_creation_over_web_to_work_reasonably&diff=112107CSC/ECE 517 Fall 2017/E17A6 Fix account creation over web to work reasonably2017-11-07T01:50:20Z<p>Cshao: /* Use Cases */</p>
<hr />
<div>== '''Introduction to Expertiza''' ==<br />
Expertiza[https://expertiza.ncsu.edu/wiki/] is a project developed using Ruby on Rails[https://en.wikipedia.org/wiki/Ruby_on_Rails]. It provides features like peer review, team assignments and submission of projects. This can be achieved by submitting code base, URL of hosted code on remote server and Wiki submissions. It is an open source application and the code can be cloned from GitHub[https://en.wikipedia.org/wiki/GitHub]. This application provides an efficient way to manage assignments, grades and reviews. This makes the process easier and faster when the class strength is large.<br />
== '''Introduction''' ==<br />
=== '''Purpose''' ===<br />
Expertiza provide the function for user to request an account, but the function is not perfect. The goal of our project is to improve this feature. It will enable Expertiza to handle the pending request for super-admin and add institution for user.<br />
<br />
=== '''Problem Definition''' ===<br />
===='''New user request page'''====<br />
*Currently, a new user can only choose institution from the dropdown. The new user should be able to add a new institution. <br />
*A place where a new user to write a brief introduction is needed in this page.<br />
*Also, in models/requested_user.rb, there are some validations, such as validate email address. It will be better to update the flash message on the view when validation fails.<br />
===='''Super-admin and admin are able to approve or decline new user requests. '''====<br />
*Currently, you have to go to /users/list_pending_requested this url to access a list of pending requests. It will be better to add an option in “Administration > Show…” menu <br />
*Make “Email Address” column in /users/list_pending_requested page clickable. So that super-admin or admin could converse with requesters by clicking email addresses directly.<br />
===='''After approving'''====<br />
*After super-admin or admin approves the request, make sure the record does not disappear on the page. And there should be an email send to email address offered by requester.<br />
<br />
== '''Requirements''' ==<br />
*Modify the test of request new user method. <br />
*Add a new option for the drop-down bar of institution in the new user request page.<br />
*Add a new textarea in the new user request page, to input a new institution and introduction.<br />
*Add validation for new institution new institutions and introductions.<br />
*Add flash message for requested_user.rb.<br />
*Add a new button on the layout.<br />
*Modify the layout of /users/list_pending_requested page.<br />
*Enable the system will send an email after the request is processed.<br />
<br />
=='''Database Design'''==<br />
[[File:17a61.JPG]]<br />
*The above tables is the original table for this project, however it lacks a column for introduction. So we need to add a new column for request_user table. The new table will be shown below.<br />
[[File:17a62.JPG]]<br />
<br />
=='''Use Cases'''==<br />
[[File:17a63.jpg]]<br />
*Name: Instructor or Teaching Assistant request a new account<br />
*Actor: Instructor or Teaching Assistant<br />
*Other Participants: None<br />
*Precondition: None<br />
*Primary Sequence:<br />
::1.Click on “Request account”.<br />
::2.Select a role.<br />
::3.Fill in a user name.<br />
::4.Fill in a full name.<br />
::5.Fill in an email address.<br />
::6.Select an institution, if the institution not in the list, skip to the alternative flow.<br />
::7.Fill in the introduction field.<br />
::8.Click on “Request”.<br />
*Alternative Flow:<br />
::1.If the institution not in the list, click on “Others”.<br />
::2.Fill in the institution name.<br />
<br />
<br />
*Name: Admin or Super admin view list of new account requests<br />
*Actor: Admin or Super admin<br />
*Other Participants: None<br />
*Precondition: Instructor or Teaching Assistant has requested a new account<br />
*Primary Sequence:<br />
::1.Log in to Expertiza.<br />
::2.Click on the link “/users/list_pending_requested”.<br />
::3.View the list of new account requests.<br />
*Alternative Flow: None<br />
<br />
<br />
*Name: Admin or Super admin accept a new account request<br />
*Actor: Admin or Super admin<br />
*Other Participants: None<br />
*Precondition: Instructor or Teaching Assistant has requested a new account<br />
*Primary Sequence:<br />
::1.Log in to Expertiza.<br />
::2.Click on the link “/users/list_pending_requested”.<br />
::3.Select a request.<br />
::4.Click on “Accept”.<br />
::5.Click on “Submit”.<br />
*Alternative Flow: None<br />
<br />
<br />
*Name: Admin or Super admin reject a new account request<br />
*Actor: Admin or Super admin<br />
*Other Participants: None<br />
*Precondition: Instructor or Teaching Assistant has requested a new account<br />
*Primary Sequence:<br />
::1.Log in to Expertiza<br />
::2.Click on the link “/users/list_pending_requested”.<br />
::3.Select a request.<br />
::4.Click on “Reject”.<br />
::5.Click on “Submit”.<br />
*Alternative Flow: None<br />
<br />
<br />
*Name: Admin or Super admin send an email to applicant<br />
*Actor: Admin or Super admin<br />
*Other Participants: None<br />
*Precondition: Instructor or Teaching Assistant has requested a new account<br />
*Primary Sequence:<br />
::1.Log in to Expertiza<br />
::2.Click on the link “/users/list_pending_requested”.<br />
::3.Select a request.<br />
::4.Click on the email address.<br />
::5.Write the email.<br />
*Alternative Flow: None<br />
<br />
=='''Design Pattern'''==<br />
==='''MVC'''===<br />
The project is implemented in Ruby on Rails that uses MVC architecture. It separates an application’s data model, user interface, and control logic into three distinct components (model, view and controller, respectively).<br />
<br />
==='''TDD'''===<br />
In this project, we follow the Test-driven development (TDD) software development process, which means that we would first write a test that fails before you write new functional code.<br />
<br />
==='''DIY'''===<br />
We are trying to reuse the existing functionalities in Expertiza, thus avoiding code duplication. Whenever possible, code modification based on the existing classes, controllers, or tables will be done instead of creating the new one.<br />
<br />
=='''Mockup Screen'''==<br />
Below are the mock-up screens that explain “new account acreation” functionality in Expertiza. <br />
*1.New user should click “request account” for requesting a new account, then redirect to the “request new ” page.<br />
[[File:17a65.jpg]]<br />
*2.After redirect to “request new ” page, new users should enter their information, includes role, name, e-mail and institution. If the institution that new users want to choose is not in the list, we can choose “others” option, then a textbox will appear. We can enter our new institution in this textbox. Finally, we can click “request” button to submit our request, and wait for being approved by administrator. <br />
[[File:17a66.jpg]]<br />
*3. If we login as administrator, we can see the screens below.<br />
[[File:17a67.jpg]]<br />
*4. If we click “show requests”, we can see this screen. The email address is clickable.<br />
[[File:17a68.jpg]]<br />
*5.If we click the email address, the email editor will pop out. Administrator can converse with requestor directly.<br />
[[File:17a6a.jpg]]</div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=111754CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-11-03T12:52:54Z<p>Cshao: /* Resources */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at using TFD(Test First Development) to refactor the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc.<br />
<br />
We used the TDF(Test First Development) method to refactor the AssignmentParticipant model. With the RSpec tool, we wrote 38 test cases for 24 methods in '''assignment_participant_spec.rb''' first. After finishing these test cases, we executed them, and most of them failed. And then we refactored the methods, '''scores''', '''files''', '''self.import''', '''find_by''', '''where.first''', and executed the test cases again, finally they all passed.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
== Test Cases ==<br />
Because the project is aimed at using TFD(Test First Development) to refactor the AssignmentParticipant model.<br />
We wrote 38 test cases for 24 methods in '''assignment_participant_spec.rb''' first, with the RSpec tool.<br />
<br />
The introduction video to our project<ref>Introduction video to our project https://www.youtube.com/watch?v=sJdmN-S2Voo&feature=youtu.be</ref><br />
describe '#dir_path' do<br />
it 'returns the directory path of current assignment' do<br />
expect(participant.dir_path).to eq "final_test"<br />
end<br />
end<br />
<br />
describe '#assign_quiz' do<br />
it 'creates a new QuizResponseMap record' do<br />
allow(QuizQuestionnaire).to receive(:find_by).with(instructor_id: 1).and_return(quiz_questionaire) # WHY CAN NOT DELETE THIS SENTENCE<br />
expect { participant.assign_quiz(participant, participant2, nil) }.to change { QuizResponseMap.count }.from(0).to(1)<br />
expect(participant.assign_quiz(participant, participant2, nil)).to be_an_instance_of(QuizResponseMap)<br />
end<br />
end<br />
<br />
describe '#reviewers' do<br />
it 'returns all the participants in this assignment who have reviewed the team where this participant belongs' do<br />
allow(ReviewResponseMap).to receive(:where).with(any_args).and_return([response_map]) # differences with .with(parameter)<br />
allow(AssignmentParticipant).to receive(:find).with(any_args).and_return(participant2)<br />
expect(participant.reviewers).to eq([participant2])<br />
end<br />
end<br />
<br />
describe '#review_score' do<br />
it 'returns the review score' do<br />
# diao yong de method tai duo le,er qie bu zhi dao sha yi si<br />
allow(review_questionnaire).to receive(:get_assessments_for).with(any_args).and_return([response])<br />
allow(review_questionnaire).to receive(:questions).and_return(question)<br />
allow(Answer).to receive(:compute_scores).with([response], question).and_return(avg: 100)<br />
allow(review_questionnaire).to receive(:max_possible_score).and_return(100)<br />
expect(participant.review_score).to eq(100)<br />
end<br />
end<br />
<br />
describe '#scores' do<br />
context 'when assignment is not varying rubric by round and not an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(false)<br />
allow(assignment).to receive(:is_microtask?).and_return(false)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
<br />
context 'when assignment is varying rubric by round but not an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(true)<br />
expect(participant).to receive(:merge_scores)<br />
allow(assignment).to receive(:is_microtask?).and_return(false)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
<br />
context 'when assignment is not varying rubric by round but an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(false)<br />
allow(assignment).to receive(:is_microtask?).and_return(true)<br />
expect(participant).to receive(:topic_total_scores)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
end<br />
<br />
# included method<br />
describe '#assignment_questionnaires' do<br />
context 'when the round of questionnaire is nil' do<br />
it 'record the result as review scores' do<br />
scores = {}<br />
question_hash = {review: question}<br />
score_map = {max: 100, min: 100, avg: 100}<br />
allow(AssignmentQuestionnaire).to receive(:find_by).with(any_args).and_return(assignment_questionnaire)<br />
allow(review_questionnaire).to receive(:get_assessments_for).with(any_args).and_return([response])<br />
allow(Answer).to receive(:compute_scores).with(any_args).and_return(score_map)<br />
participant.assignment_questionnaires(question_hash, scores)<br />
expect(scores[:review][:assessments]).to eq([response])<br />
expect(scores[:review][:scores]).to eq(score_map)<br />
end<br />
end<br />
<br />
context 'when the round of questionnaire is not nil' do<br />
it 'record the result as review#{n} scores' do<br />
scores = {}<br />
question_hash = {review1: question}<br />
score_map = {max: 100, min: 100, avg: 100}<br />
allow(AssignmentQuestionnaire).to receive(:find_by).and_return(assignment_questionnaire2)<br />
allow(review_questionnaire).to receive(:get_assessments_round_for).with(any_args).and_return([response])<br />
allow(Answer).to receive(:compute_scores).with(any_args).and_return(score_map)<br />
participant.assignment_questionnaires(question_hash, scores)<br />
expect(scores[:review1][:assessments]).to eq([response])<br />
expect(scores[:review1][:scores]).to eq(score_map)<br />
end<br />
end<br />
end<br />
<br />
describe '#merge_scores' do<br />
context 'when all of the review_n are nil' do<br />
it 'set max, min, avg of review score as 0' do<br />
scores = {}<br />
allow(assignment).to receive(:num_review_rounds).and_return(1)<br />
participant.merge_scores(scores)<br />
expect(scores[:review][:scores][:max]).to eq(0)<br />
expect(scores[:review][:scores][:min]).to eq(0)<br />
expect(scores[:review][:scores][:min]).to eq(0)<br />
end<br />
end<br />
<br />
context 'when the review_n is not nil' do<br />
it 'merge the score of review_n to the score of review' do<br />
score_map = {max: 100, min: 100, avg: 100}<br />
scores = {review1: {scores: score_map, assessments: [response]}}<br />
allow(assignment).to receive(:num_review_rounds).and_return(1)<br />
participant.merge_scores(scores)<br />
expect(scores[:review][:scores][:max]).to eq(100)<br />
expect(scores[:review][:scores][:min]).to eq(100)<br />
expect(scores[:review][:scores][:min]).to eq(100)<br />
end<br />
end<br />
end<br />
<br />
describe '#topic_total_scores' do<br />
it 'set total_score and max_pts_available of score when topic is not nil' do<br />
scores = {total_score: 100}<br />
allow(SignUpTopic).to receive(:find_by).with(any_args).and_return(topic)<br />
participant.topic_total_scores(scores)<br />
expect(scores[:total_score]).to eq(0)<br />
expect(scores[:max_pts_available]).to eq(0)<br />
end<br />
end<br />
<br />
describe '#caculate_scores' do<br />
context 'when the participant has the grade' do<br />
it 'his total scores equals his grade' do<br />
scores = {}<br />
expect(participant2.caculate_scores(scores)).to eq(100.0)<br />
end<br />
end<br />
context 'when the participant has the grade and the total score more than 100' do<br />
it 'return the score of a given participant with total score 100' do<br />
scores = {total_score: 110}<br />
expect(participant.caculate_scores(scores)).to eq(total_score: 100)<br />
end<br />
end<br />
context 'when the participant has the grade and the total score less than 100' do<br />
it 'return the score of a given participant with total score' do<br />
scores = {total_score: 90}<br />
expect(participant.caculate_scores(scores)).to eq(total_score: 90)<br />
end<br />
end<br />
end<br />
<br />
describe '#copy' do<br />
it 'copies assignment participants to a certain course' do<br />
expect(participant.copy(517)).to be_an_instance_of(CourseParticipant)<br />
end<br />
end<br />
<br />
describe '#feedback' do<br />
it 'returns corrsponding author feedback responses given by current participant' do<br />
expect(participant.feedback).to eq([response])<br />
end<br />
end<br />
<br />
describe '#reviews' do<br />
it 'returns corrsponding peer review responses given by current team' do<br />
expect(participant.reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#reviews_by_reviewer' do<br />
it 'returns corrsponding peer review responses given by certain reviewer' do<br />
allow(ReviewResponseMap).to receive(:get_reviewer_assessments_for).with(team, participant2).and_return([response])<br />
expect(participant.reviews_by_reviewer(participant2)).to eq([response])<br />
end<br />
end<br />
<br />
describe '#quizzes_taken' do<br />
it 'returns corrsponding quiz responses given by current participant' do<br />
expect(participant.quizzes_taken).to eq([response])<br />
end<br />
end<br />
<br />
describe '#metareviews' do<br />
it 'returns corrsponding metareview responses given by current participant' do<br />
expect(participant.metareviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#teammate_reviews' do<br />
it 'returns corrsponding teammate review responses given by current participant' do<br />
expect(participant.teammate_reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#bookmark_reviews' do<br />
it 'returns corrsponding bookmark review responses given by current participant' do<br />
expect(participant.bookmark_reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#files' do<br />
context 'when there is not subdirectory in current directory' do<br />
it 'returns all files in current directory' do<br />
allow(Dir).to receive(:[]).with("a/*").and_return(["a/k.rb"])<br />
allow(File).to receive(:directory?).with("a/k.rb").and_return(false)<br />
expect(participant.files("a")).to eq(["a/k.rb"])<br />
end<br />
end<br />
<br />
context 'when there is subdirectory in current directory' do<br />
it 'recursively returns all files in current directory' do<br />
allow(Dir).to receive(:[]).with("a/*").and_return(["a/b"])<br />
allow(File).to receive(:directory?).with("a/b").and_return(true)<br />
allow(Dir).to receive(:[]).with("a/b/*").and_return(["a/b/k.rb"])<br />
allow(File).to receive(:directory?).with("a/b/k.rb").and_return(false)<br />
expect(participant.files("a")).to eq(["a/b/k.rb", "a/b"])<br />
end<br />
end<br />
end<br />
<br />
describe ".import" do<br />
context 'when record is empty' do<br />
it 'raises an ArgumentError' do<br />
row = []<br />
allow(AssignmentParticipant).to receive(:check_info_and_create).with(any_args).and_raise("No user id has been specified.")<br />
expect(AssignmentParticipant).to receive(:check_info_and_create)<br />
expect { AssignmentParticipant.import(row, nil, nil, nil) }.to raise_error("No user id has been specified.")<br />
end<br />
end<br />
<br />
context 'when no user is found by offered username' do<br />
context 'when the record has less than 4 items' do<br />
it 'raises an ArgumentError' do<br />
row = ["user_name", "user_fullname", "name@email.com"]<br />
allow(AssignmentParticipant).<br />
to receive(:check_info_and_create).with(any_args).and_raise("The record containing #{row[0]} does not have enough items.")<br />
expect(AssignmentParticipant).to receive(:check_info_and_create)<br />
expect { AssignmentParticipant.import(row, nil, nil, nil) }.to raise_error("The record containing #{row[0]} does not have enough items.")<br />
end<br />
end<br />
<br />
context 'when the record has more than 4 items' do<br />
context 'when certain assignment cannot be found' do<br />
it 'creates a new user based on import information and raises an ImportError' do<br />
row = ["user_name", "user_fullname", "name@email.com", "user_role_name", "user_parent_name"]<br />
session = {user: participant}<br />
allow(User).to receive(:find_by).with(any_args).and_return(nil)<br />
allow(Assignment).to receive(:find).with(2).and_return(nil)<br />
expect { AssignmentParticipant.import(row, nil, session, 2) }.<br />
to raise_error("The assignment with id \"2\" was not found.").and change { User.count }.by(1)<br />
end<br />
end<br />
<br />
context 'when certain assignment can be found and assignment participant does not exists' do<br />
it 'creates a new user, new participant and raises an ImportError' do<br />
row = ["user_name", "user_fullname", "name@email.com", "user_role_name", "user_parent_name"]<br />
session = {user: participant}<br />
allow(User).to receive(:find_by_name).with(any_args).and_return(nil)<br />
allow(Assignment).to receive(:find).with(2).and_return(assignment)<br />
allow(AssignmentParticipant).to receive(:exists?).and_return(false)<br />
expect { AssignmentParticipant.import(row, nil, session, 2) }.to change { User.count }.by(1).and change { AssignmentParticipant.count }.by(1)<br />
end<br />
end<br />
end<br />
end<br />
end<br />
<br />
describe '.export' do<br />
it 'exports all participants in current assignment' do<br />
csv = []<br />
expect(AssignmentParticipant).to receive_message_chain(:where, :find_each).with(any_args).and_yield(participant)<br />
expect(AssignmentParticipant.export(csv, 1, any_args)).<br />
to eq([["student2064", "2064, student", "expertiza@mailinator.com", "Student", "instructor6", true, true, true, "handle"]])<br />
end<br />
end<br />
<br />
describe '#set_handle' do<br />
context 'when the user of current participant does not have handle' do<br />
it 'sets the user name as the handle of current participant' do<br />
allow(student).to receive_message_chain(:handle, :nil?).and_return(true)<br />
allow(student).to receive(:handle).and_return("")<br />
participant.set_handle<br />
expect(participant.handle).to eq("student2064")<br />
end<br />
end<br />
<br />
context 'when current assignment exists participants with same handle as the one of current user' do<br />
it 'sets the user name as the name of current participant' do<br />
allow(AssignmentParticipant).to receive(:exists?).with(any_args).and_return(true)<br />
participant.set_handle<br />
expect(participant.handle).to eq("student2064")<br />
end<br />
end<br />
<br />
context 'when current assignment does not have participants with same handle as the one of current user' do<br />
it 'sets the user name as the handle of current participant' do<br />
participant.set_handle<br />
expect(participant.handle).to eq("handle")<br />
end<br />
end<br />
end<br />
<br />
describe '#review_file_path' do<br />
it 'returns the file path for reviewer to upload files during peer review' do<br />
allow(ResponseMap).to receive(:find).with(any_args).and_return(response_map)<br />
allow(TeamsUser).to receive_message_chain(:find_by, :user_id).with(any_args).and_return(1)<br />
allow(Participant).to receive(:find_by).with(any_args).and_return(participant)<br />
file_path = Rails.root.to_s + "/pg_data/instructor6/csc517/test/final_test/0_review/1"<br />
expect(participant.review_file_path(1)).to eq(file_path)<br />
end<br />
end<br />
<br />
describe '#current_stage' do<br />
it 'returns stage of current assignment' do<br />
allow(assignment).to receive(:get_current_stage).with(1).and_return("Finished")<br />
expect(participant.current_stage).to eq("Finished")<br />
end<br />
end<br />
<br />
describe '#stage_deadline' do<br />
context 'when stage of current assignment is not Finished' do<br />
it 'returns current stage' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Unknow")<br />
expect(participant.stage_deadline).to eq("Unknow")<br />
end<br />
end<br />
<br />
context 'when stage of current assignment not Finished' do<br />
context 'current assignment is not a staggered deadline assignment' do<br />
it 'returns the due date of current assignment' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Finished")<br />
allow(assignment).to receive(:staggered_deadline?).and_return(false)<br />
allow(assignment).to receive_message_chain(:due_dates, :last, :due_at).and_return(1)<br />
expect(participant.stage_deadline).to eq("1")<br />
end<br />
end<br />
<br />
context 'current assignment is a staggered deadline assignment' do<br />
it 'returns the due date of current topic' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Finished")<br />
allow(assignment).to receive(:staggered_deadline?).and_return(true)<br />
allow(TopicDueDate).to receive_message_chain(:find_by, :last, :due_at).and_return(1)<br />
expect(participant.stage_deadline).to eq("1")<br />
end<br />
end<br />
end<br />
end<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===Files method===<br />
The files method of AssignmentParticipant model is exactly the same as '''assignment_team.rb, L103''', so we move it to a module named Instance_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and AssignmentTeam model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Instance_method<br />
<br />
* module Instance_method<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = []<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each {|f| files << f }<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
===Self.import method===<br />
The self.import method of AssignmentParticipant model is exactly the same as '''course_participant.rb, L21''', so we move it to a module named Class_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and CourseParticipant model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Class_method<br />
<br />
def self.import(row, _row_header = nil, session, id)<br />
user = AssignmentParticipant.check_info_and_create(row, _row_header = nil, session)<br />
raise ImportError, "The assignment with id \"" + id.to_s + "\" was not found." if Assignment.find(id).nil?<br />
unless AssignmentParticipant.exists?(user_id: user.id, parent_id: id)<br />
new_part = AssignmentParticipant.create(user_id: user.id, parent_id: id)<br />
new_part.set_handle<br />
end<br />
end<br />
<br />
* module Class_method<br />
def check_info_and_create(row, _row_header = nil, session)<br />
raise ArgumentError, "No user id has been specified." if row.empty?<br />
user = User.find_by(name: row[0])<br />
if user.nil?<br />
raise ArgumentError, "The record containing #{row[0]} does not have enough items." if row.length < 4<br />
attributes = ImportFileHelper.define_attributes(row)<br />
user = ImportFileHelper.create_new_user(attributes, session)<br />
end<br />
end<br />
<br />
===Find_by method===<br />
Use '''find_by''' instead of dynamic method<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by(name:row[0])<br />
|-<br />
|}<br />
<br />
Use '''find_by''' instead of where.first<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github repository https://github.com/terryliu1995/expertiza</ref><br />
* Our pull request<ref>Our pull request https://github.com/expertiza/expertiza/pull/1049</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109705CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T04:14:42Z<p>Cshao: /* Test */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at using TFD(Test First Development) to refactor the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc.<br />
<br />
We used the TDF(Test First Development) method to refactor the AssignmentParticipant model. With the RSpec tool, we wrote 38 test cases for 24 methods in '''assignment_participant_spec.rb''' first. After finishing these test cases, we executed them, and most of them failed. And then we refactored the methods, '''scores''', '''files''', '''self.import''', '''find_by''', '''where.first''', and executed the test cases again, finally they all passed.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
== Test Cases ==<br />
Because the project is aimed at using TFD(Test First Development) to refactor the AssignmentParticipant model.<br />
We wrote 38 test cases for 24 methods in '''assignment_participant_spec.rb''' first, with the RSpec tool.<br />
<br />
The introduction video to our project<ref>Introduction video to our project https://www.youtube.com/watch?v=sJdmN-S2Voo&feature=youtu.be</ref><br />
describe '#dir_path' do<br />
it 'returns the directory path of current assignment' do<br />
expect(participant.dir_path).to eq "final_test"<br />
end<br />
end<br />
<br />
describe '#assign_quiz' do<br />
it 'creates a new QuizResponseMap record' do<br />
allow(QuizQuestionnaire).to receive(:find_by).with(instructor_id: 1).and_return(quiz_questionaire) # WHY CAN NOT DELETE THIS SENTENCE<br />
expect { participant.assign_quiz(participant, participant2, nil) }.to change { QuizResponseMap.count }.from(0).to(1)<br />
expect(participant.assign_quiz(participant, participant2, nil)).to be_an_instance_of(QuizResponseMap)<br />
end<br />
end<br />
<br />
describe '#reviewers' do<br />
it 'returns all the participants in this assignment who have reviewed the team where this participant belongs' do<br />
allow(ReviewResponseMap).to receive(:where).with(any_args).and_return([response_map]) # differences with .with(parameter)<br />
allow(AssignmentParticipant).to receive(:find).with(any_args).and_return(participant2)<br />
expect(participant.reviewers).to eq([participant2])<br />
end<br />
end<br />
<br />
describe '#review_score' do<br />
it 'returns the review score' do<br />
# diao yong de method tai duo le,er qie bu zhi dao sha yi si<br />
allow(review_questionnaire).to receive(:get_assessments_for).with(any_args).and_return([response])<br />
allow(review_questionnaire).to receive(:questions).and_return(question)<br />
allow(Answer).to receive(:compute_scores).with([response], question).and_return(avg: 100)<br />
allow(review_questionnaire).to receive(:max_possible_score).and_return(100)<br />
expect(participant.review_score).to eq(100)<br />
end<br />
end<br />
<br />
describe '#scores' do<br />
context 'when assignment is not varying rubric by round and not an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(false)<br />
allow(assignment).to receive(:is_microtask?).and_return(false)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
<br />
context 'when assignment is varying rubric by round but not an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(true)<br />
expect(participant).to receive(:merge_scores)<br />
allow(assignment).to receive(:is_microtask?).and_return(false)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
<br />
context 'when assignment is not varying rubric by round but an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(false)<br />
allow(assignment).to receive(:is_microtask?).and_return(true)<br />
expect(participant).to receive(:topic_total_scores)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
end<br />
<br />
# included method<br />
describe '#assignment_questionnaires' do<br />
context 'when the round of questionnaire is nil' do<br />
it 'record the result as review scores' do<br />
scores = {}<br />
question_hash = {review: question}<br />
score_map = {max: 100, min: 100, avg: 100}<br />
allow(AssignmentQuestionnaire).to receive(:find_by).with(any_args).and_return(assignment_questionnaire)<br />
allow(review_questionnaire).to receive(:get_assessments_for).with(any_args).and_return([response])<br />
allow(Answer).to receive(:compute_scores).with(any_args).and_return(score_map)<br />
participant.assignment_questionnaires(question_hash, scores)<br />
expect(scores[:review][:assessments]).to eq([response])<br />
expect(scores[:review][:scores]).to eq(score_map)<br />
end<br />
end<br />
<br />
context 'when the round of questionnaire is not nil' do<br />
it 'record the result as review#{n} scores' do<br />
scores = {}<br />
question_hash = {review1: question}<br />
score_map = {max: 100, min: 100, avg: 100}<br />
allow(AssignmentQuestionnaire).to receive(:find_by).and_return(assignment_questionnaire2)<br />
allow(review_questionnaire).to receive(:get_assessments_round_for).with(any_args).and_return([response])<br />
allow(Answer).to receive(:compute_scores).with(any_args).and_return(score_map)<br />
participant.assignment_questionnaires(question_hash, scores)<br />
expect(scores[:review1][:assessments]).to eq([response])<br />
expect(scores[:review1][:scores]).to eq(score_map)<br />
end<br />
end<br />
end<br />
<br />
describe '#merge_scores' do<br />
context 'when all of the review_n are nil' do<br />
it 'set max, min, avg of review score as 0' do<br />
scores = {}<br />
allow(assignment).to receive(:num_review_rounds).and_return(1)<br />
participant.merge_scores(scores)<br />
expect(scores[:review][:scores][:max]).to eq(0)<br />
expect(scores[:review][:scores][:min]).to eq(0)<br />
expect(scores[:review][:scores][:min]).to eq(0)<br />
end<br />
end<br />
<br />
context 'when the review_n is not nil' do<br />
it 'merge the score of review_n to the score of review' do<br />
score_map = {max: 100, min: 100, avg: 100}<br />
scores = {review1: {scores: score_map, assessments: [response]}}<br />
allow(assignment).to receive(:num_review_rounds).and_return(1)<br />
participant.merge_scores(scores)<br />
expect(scores[:review][:scores][:max]).to eq(100)<br />
expect(scores[:review][:scores][:min]).to eq(100)<br />
expect(scores[:review][:scores][:min]).to eq(100)<br />
end<br />
end<br />
end<br />
<br />
describe '#topic_total_scores' do<br />
it 'set total_score and max_pts_available of score when topic is not nil' do<br />
scores = {total_score: 100}<br />
allow(SignUpTopic).to receive(:find_by).with(any_args).and_return(topic)<br />
participant.topic_total_scores(scores)<br />
expect(scores[:total_score]).to eq(0)<br />
expect(scores[:max_pts_available]).to eq(0)<br />
end<br />
end<br />
<br />
describe '#caculate_scores' do<br />
context 'when the participant has the grade' do<br />
it 'his total scores equals his grade' do<br />
scores = {}<br />
expect(participant2.caculate_scores(scores)).to eq(100.0)<br />
end<br />
end<br />
context 'when the participant has the grade and the total score more than 100' do<br />
it 'return the score of a given participant with total score 100' do<br />
scores = {total_score: 110}<br />
expect(participant.caculate_scores(scores)).to eq(total_score: 100)<br />
end<br />
end<br />
context 'when the participant has the grade and the total score less than 100' do<br />
it 'return the score of a given participant with total score' do<br />
scores = {total_score: 90}<br />
expect(participant.caculate_scores(scores)).to eq(total_score: 90)<br />
end<br />
end<br />
end<br />
<br />
describe '#copy' do<br />
it 'copies assignment participants to a certain course' do<br />
expect(participant.copy(517)).to be_an_instance_of(CourseParticipant)<br />
end<br />
end<br />
<br />
describe '#feedback' do<br />
it 'returns corrsponding author feedback responses given by current participant' do<br />
expect(participant.feedback).to eq([response])<br />
end<br />
end<br />
<br />
describe '#reviews' do<br />
it 'returns corrsponding peer review responses given by current team' do<br />
expect(participant.reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#reviews_by_reviewer' do<br />
it 'returns corrsponding peer review responses given by certain reviewer' do<br />
allow(ReviewResponseMap).to receive(:get_reviewer_assessments_for).with(team, participant2).and_return([response])<br />
expect(participant.reviews_by_reviewer(participant2)).to eq([response])<br />
end<br />
end<br />
<br />
describe '#quizzes_taken' do<br />
it 'returns corrsponding quiz responses given by current participant' do<br />
expect(participant.quizzes_taken).to eq([response])<br />
end<br />
end<br />
<br />
describe '#metareviews' do<br />
it 'returns corrsponding metareview responses given by current participant' do<br />
expect(participant.metareviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#teammate_reviews' do<br />
it 'returns corrsponding teammate review responses given by current participant' do<br />
expect(participant.teammate_reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#bookmark_reviews' do<br />
it 'returns corrsponding bookmark review responses given by current participant' do<br />
expect(participant.bookmark_reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#files' do<br />
context 'when there is not subdirectory in current directory' do<br />
it 'returns all files in current directory' do<br />
allow(Dir).to receive(:[]).with("a/*").and_return(["a/k.rb"])<br />
allow(File).to receive(:directory?).with("a/k.rb").and_return(false)<br />
expect(participant.files("a")).to eq(["a/k.rb"])<br />
end<br />
end<br />
<br />
context 'when there is subdirectory in current directory' do<br />
it 'recursively returns all files in current directory' do<br />
allow(Dir).to receive(:[]).with("a/*").and_return(["a/b"])<br />
allow(File).to receive(:directory?).with("a/b").and_return(true)<br />
allow(Dir).to receive(:[]).with("a/b/*").and_return(["a/b/k.rb"])<br />
allow(File).to receive(:directory?).with("a/b/k.rb").and_return(false)<br />
expect(participant.files("a")).to eq(["a/b/k.rb", "a/b"])<br />
end<br />
end<br />
end<br />
<br />
describe ".import" do<br />
context 'when record is empty' do<br />
it 'raises an ArgumentError' do<br />
row = []<br />
allow(AssignmentParticipant).to receive(:check_info_and_create).with(any_args).and_raise("No user id has been specified.")<br />
expect(AssignmentParticipant).to receive(:check_info_and_create)<br />
expect { AssignmentParticipant.import(row, nil, nil, nil) }.to raise_error("No user id has been specified.")<br />
end<br />
end<br />
<br />
context 'when no user is found by offered username' do<br />
context 'when the record has less than 4 items' do<br />
it 'raises an ArgumentError' do<br />
row = ["user_name", "user_fullname", "name@email.com"]<br />
allow(AssignmentParticipant).<br />
to receive(:check_info_and_create).with(any_args).and_raise("The record containing #{row[0]} does not have enough items.")<br />
expect(AssignmentParticipant).to receive(:check_info_and_create)<br />
expect { AssignmentParticipant.import(row, nil, nil, nil) }.to raise_error("The record containing #{row[0]} does not have enough items.")<br />
end<br />
end<br />
<br />
context 'when the record has more than 4 items' do<br />
context 'when certain assignment cannot be found' do<br />
it 'creates a new user based on import information and raises an ImportError' do<br />
row = ["user_name", "user_fullname", "name@email.com", "user_role_name", "user_parent_name"]<br />
session = {user: participant}<br />
allow(User).to receive(:find_by).with(any_args).and_return(nil)<br />
allow(Assignment).to receive(:find).with(2).and_return(nil)<br />
expect { AssignmentParticipant.import(row, nil, session, 2) }.<br />
to raise_error("The assignment with id \"2\" was not found.").and change { User.count }.by(1)<br />
end<br />
end<br />
<br />
context 'when certain assignment can be found and assignment participant does not exists' do<br />
it 'creates a new user, new participant and raises an ImportError' do<br />
row = ["user_name", "user_fullname", "name@email.com", "user_role_name", "user_parent_name"]<br />
session = {user: participant}<br />
allow(User).to receive(:find_by_name).with(any_args).and_return(nil)<br />
allow(Assignment).to receive(:find).with(2).and_return(assignment)<br />
allow(AssignmentParticipant).to receive(:exists?).and_return(false)<br />
expect { AssignmentParticipant.import(row, nil, session, 2) }.to change { User.count }.by(1).and change { AssignmentParticipant.count }.by(1)<br />
end<br />
end<br />
end<br />
end<br />
end<br />
<br />
describe '.export' do<br />
it 'exports all participants in current assignment' do<br />
csv = []<br />
expect(AssignmentParticipant).to receive_message_chain(:where, :find_each).with(any_args).and_yield(participant)<br />
expect(AssignmentParticipant.export(csv, 1, any_args)).<br />
to eq([["student2064", "2064, student", "expertiza@mailinator.com", "Student", "instructor6", true, true, true, "handle"]])<br />
end<br />
end<br />
<br />
describe '#set_handle' do<br />
context 'when the user of current participant does not have handle' do<br />
it 'sets the user name as the handle of current participant' do<br />
allow(student).to receive_message_chain(:handle, :nil?).and_return(true)<br />
allow(student).to receive(:handle).and_return("")<br />
participant.set_handle<br />
expect(participant.handle).to eq("student2064")<br />
end<br />
end<br />
<br />
context 'when current assignment exists participants with same handle as the one of current user' do<br />
it 'sets the user name as the name of current participant' do<br />
allow(AssignmentParticipant).to receive(:exists?).with(any_args).and_return(true)<br />
participant.set_handle<br />
expect(participant.handle).to eq("student2064")<br />
end<br />
end<br />
<br />
context 'when current assignment does not have participants with same handle as the one of current user' do<br />
it 'sets the user name as the handle of current participant' do<br />
participant.set_handle<br />
expect(participant.handle).to eq("handle")<br />
end<br />
end<br />
end<br />
<br />
describe '#review_file_path' do<br />
it 'returns the file path for reviewer to upload files during peer review' do<br />
allow(ResponseMap).to receive(:find).with(any_args).and_return(response_map)<br />
allow(TeamsUser).to receive_message_chain(:find_by, :user_id).with(any_args).and_return(1)<br />
allow(Participant).to receive(:find_by).with(any_args).and_return(participant)<br />
file_path = Rails.root.to_s + "/pg_data/instructor6/csc517/test/final_test/0_review/1"<br />
expect(participant.review_file_path(1)).to eq(file_path)<br />
end<br />
end<br />
<br />
describe '#current_stage' do<br />
it 'returns stage of current assignment' do<br />
allow(assignment).to receive(:get_current_stage).with(1).and_return("Finished")<br />
expect(participant.current_stage).to eq("Finished")<br />
end<br />
end<br />
<br />
describe '#stage_deadline' do<br />
context 'when stage of current assignment is not Finished' do<br />
it 'returns current stage' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Unknow")<br />
expect(participant.stage_deadline).to eq("Unknow")<br />
end<br />
end<br />
<br />
context 'when stage of current assignment not Finished' do<br />
context 'current assignment is not a staggered deadline assignment' do<br />
it 'returns the due date of current assignment' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Finished")<br />
allow(assignment).to receive(:staggered_deadline?).and_return(false)<br />
allow(assignment).to receive_message_chain(:due_dates, :last, :due_at).and_return(1)<br />
expect(participant.stage_deadline).to eq("1")<br />
end<br />
end<br />
<br />
context 'current assignment is a staggered deadline assignment' do<br />
it 'returns the due date of current topic' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Finished")<br />
allow(assignment).to receive(:staggered_deadline?).and_return(true)<br />
allow(TopicDueDate).to receive_message_chain(:find_by, :last, :due_at).and_return(1)<br />
expect(participant.stage_deadline).to eq("1")<br />
end<br />
end<br />
end<br />
end<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===Files method===<br />
The files method of AssignmentParticipant model is exactly the same as '''assignment_team.rb, L103''', so we move it to a module named Instance_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and AssignmentTeam model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Instance_method<br />
<br />
* module Instance_method<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = []<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each {|f| files << f }<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
===Self.import method===<br />
The self.import method of AssignmentParticipant model is exactly the same as '''course_participant.rb, L21''', so we move it to a module named Class_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and CourseParticipant model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Class_method<br />
<br />
def self.import(row, _row_header = nil, session, id)<br />
user = AssignmentParticipant.check_info_and_create(row, _row_header = nil, session)<br />
raise ImportError, "The assignment with id \"" + id.to_s + "\" was not found." if Assignment.find(id).nil?<br />
unless AssignmentParticipant.exists?(user_id: user.id, parent_id: id)<br />
new_part = AssignmentParticipant.create(user_id: user.id, parent_id: id)<br />
new_part.set_handle<br />
end<br />
end<br />
<br />
* module Class_method<br />
def check_info_and_create(row, _row_header = nil, session)<br />
raise ArgumentError, "No user id has been specified." if row.empty?<br />
user = User.find_by(name: row[0])<br />
if user.nil?<br />
raise ArgumentError, "The record containing #{row[0]} does not have enough items." if row.length < 4<br />
attributes = ImportFileHelper.define_attributes(row)<br />
user = ImportFileHelper.create_new_user(attributes, session)<br />
end<br />
end<br />
<br />
===Find_by method===<br />
Use '''find_by''' instead of dynamic method<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by(name:row[0])<br />
|-<br />
|}<br />
<br />
Use '''find_by''' instead of where.first<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109704CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T04:10:55Z<p>Cshao: /* Test */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at using TFD(Test First Development) to refactor the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc.<br />
<br />
We used the TDF(Test First Development) method to refactor the AssignmentParticipant model. With the RSpec tool, we wrote 38 test cases for 24 methods in '''assignment_participant_spec.rb''' first. After finishing these test cases, we executed them, and most of them failed. And then we refactored the methods, '''scores''', '''files''', '''self.import''', '''find_by''', '''where.first''', and executed the test cases again, finally they all passed.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
== Test ==<br />
Because the project is aimed at using TFD(Test First Development) to refactor the AssignmentParticipant model.<br />
We wrote 38 test cases for 24 methods in '''assignment_participant_spec.rb''' first, with the RSpec tool.<br />
<br />
The introduction video to our project<ref>Introduction video to our project https://www.youtube.com/watch?v=sJdmN-S2Voo&feature=youtu.be</ref><br />
describe '#dir_path' do<br />
it 'returns the directory path of current assignment' do<br />
expect(participant.dir_path).to eq "final_test"<br />
end<br />
end<br />
<br />
describe '#assign_quiz' do<br />
it 'creates a new QuizResponseMap record' do<br />
allow(QuizQuestionnaire).to receive(:find_by).with(instructor_id: 1).and_return(quiz_questionaire) # WHY CAN NOT DELETE THIS SENTENCE<br />
expect { participant.assign_quiz(participant, participant2, nil) }.to change { QuizResponseMap.count }.from(0).to(1)<br />
expect(participant.assign_quiz(participant, participant2, nil)).to be_an_instance_of(QuizResponseMap)<br />
end<br />
end<br />
<br />
describe '#reviewers' do<br />
it 'returns all the participants in this assignment who have reviewed the team where this participant belongs' do<br />
allow(ReviewResponseMap).to receive(:where).with(any_args).and_return([response_map]) # differences with .with(parameter)<br />
allow(AssignmentParticipant).to receive(:find).with(any_args).and_return(participant2)<br />
expect(participant.reviewers).to eq([participant2])<br />
end<br />
end<br />
<br />
describe '#review_score' do<br />
it 'returns the review score' do<br />
# diao yong de method tai duo le,er qie bu zhi dao sha yi si<br />
allow(review_questionnaire).to receive(:get_assessments_for).with(any_args).and_return([response])<br />
allow(review_questionnaire).to receive(:questions).and_return(question)<br />
allow(Answer).to receive(:compute_scores).with([response], question).and_return(avg: 100)<br />
allow(review_questionnaire).to receive(:max_possible_score).and_return(100)<br />
expect(participant.review_score).to eq(100)<br />
end<br />
end<br />
<br />
describe '#scores' do<br />
context 'when assignment is not varying rubric by round and not an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(false)<br />
allow(assignment).to receive(:is_microtask?).and_return(false)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
<br />
context 'when assignment is varying rubric by round but not an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(true)<br />
expect(participant).to receive(:merge_scores)<br />
allow(assignment).to receive(:is_microtask?).and_return(false)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
<br />
context 'when assignment is not varying rubric by round but an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(false)<br />
allow(assignment).to receive(:is_microtask?).and_return(true)<br />
expect(participant).to receive(:topic_total_scores)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
end<br />
<br />
# included method<br />
describe '#assignment_questionnaires' do<br />
context 'when the round of questionnaire is nil' do<br />
it 'record the result as review scores' do<br />
scores = {}<br />
question_hash = {review: question}<br />
score_map = {max: 100, min: 100, avg: 100}<br />
allow(AssignmentQuestionnaire).to receive(:find_by).with(any_args).and_return(assignment_questionnaire)<br />
allow(review_questionnaire).to receive(:get_assessments_for).with(any_args).and_return([response])<br />
allow(Answer).to receive(:compute_scores).with(any_args).and_return(score_map)<br />
participant.assignment_questionnaires(question_hash, scores)<br />
expect(scores[:review][:assessments]).to eq([response])<br />
expect(scores[:review][:scores]).to eq(score_map)<br />
end<br />
end<br />
<br />
context 'when the round of questionnaire is not nil' do<br />
it 'record the result as review#{n} scores' do<br />
scores = {}<br />
question_hash = {review1: question}<br />
score_map = {max: 100, min: 100, avg: 100}<br />
allow(AssignmentQuestionnaire).to receive(:find_by).and_return(assignment_questionnaire2)<br />
allow(review_questionnaire).to receive(:get_assessments_round_for).with(any_args).and_return([response])<br />
allow(Answer).to receive(:compute_scores).with(any_args).and_return(score_map)<br />
participant.assignment_questionnaires(question_hash, scores)<br />
expect(scores[:review1][:assessments]).to eq([response])<br />
expect(scores[:review1][:scores]).to eq(score_map)<br />
end<br />
end<br />
end<br />
<br />
describe '#merge_scores' do<br />
context 'when all of the review_n are nil' do<br />
it 'set max, min, avg of review score as 0' do<br />
scores = {}<br />
allow(assignment).to receive(:num_review_rounds).and_return(1)<br />
participant.merge_scores(scores)<br />
expect(scores[:review][:scores][:max]).to eq(0)<br />
expect(scores[:review][:scores][:min]).to eq(0)<br />
expect(scores[:review][:scores][:min]).to eq(0)<br />
end<br />
end<br />
<br />
context 'when the review_n is not nil' do<br />
it 'merge the score of review_n to the score of review' do<br />
score_map = {max: 100, min: 100, avg: 100}<br />
scores = {review1: {scores: score_map, assessments: [response]}}<br />
allow(assignment).to receive(:num_review_rounds).and_return(1)<br />
participant.merge_scores(scores)<br />
expect(scores[:review][:scores][:max]).to eq(100)<br />
expect(scores[:review][:scores][:min]).to eq(100)<br />
expect(scores[:review][:scores][:min]).to eq(100)<br />
end<br />
end<br />
end<br />
<br />
describe '#topic_total_scores' do<br />
it 'set total_score and max_pts_available of score when topic is not nil' do<br />
scores = {total_score: 100}<br />
allow(SignUpTopic).to receive(:find_by).with(any_args).and_return(topic)<br />
participant.topic_total_scores(scores)<br />
expect(scores[:total_score]).to eq(0)<br />
expect(scores[:max_pts_available]).to eq(0)<br />
end<br />
end<br />
<br />
describe '#caculate_scores' do<br />
context 'when the participant has the grade' do<br />
it 'his total scores equals his grade' do<br />
scores = {}<br />
expect(participant2.caculate_scores(scores)).to eq(100.0)<br />
end<br />
end<br />
context 'when the participant has the grade and the total score more than 100' do<br />
it 'return the score of a given participant with total score 100' do<br />
scores = {total_score: 110}<br />
expect(participant.caculate_scores(scores)).to eq(total_score: 100)<br />
end<br />
end<br />
context 'when the participant has the grade and the total score less than 100' do<br />
it 'return the score of a given participant with total score' do<br />
scores = {total_score: 90}<br />
expect(participant.caculate_scores(scores)).to eq(total_score: 90)<br />
end<br />
end<br />
end<br />
<br />
describe '#copy' do<br />
it 'copies assignment participants to a certain course' do<br />
expect(participant.copy(517)).to be_an_instance_of(CourseParticipant)<br />
end<br />
end<br />
<br />
describe '#feedback' do<br />
it 'returns corrsponding author feedback responses given by current participant' do<br />
expect(participant.feedback).to eq([response])<br />
end<br />
end<br />
<br />
describe '#reviews' do<br />
it 'returns corrsponding peer review responses given by current team' do<br />
expect(participant.reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#reviews_by_reviewer' do<br />
it 'returns corrsponding peer review responses given by certain reviewer' do<br />
allow(ReviewResponseMap).to receive(:get_reviewer_assessments_for).with(team, participant2).and_return([response])<br />
expect(participant.reviews_by_reviewer(participant2)).to eq([response])<br />
end<br />
end<br />
<br />
describe '#quizzes_taken' do<br />
it 'returns corrsponding quiz responses given by current participant' do<br />
expect(participant.quizzes_taken).to eq([response])<br />
end<br />
end<br />
<br />
describe '#metareviews' do<br />
it 'returns corrsponding metareview responses given by current participant' do<br />
expect(participant.metareviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#teammate_reviews' do<br />
it 'returns corrsponding teammate review responses given by current participant' do<br />
expect(participant.teammate_reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#bookmark_reviews' do<br />
it 'returns corrsponding bookmark review responses given by current participant' do<br />
expect(participant.bookmark_reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#files' do<br />
context 'when there is not subdirectory in current directory' do<br />
it 'returns all files in current directory' do<br />
allow(Dir).to receive(:[]).with("a/*").and_return(["a/k.rb"])<br />
allow(File).to receive(:directory?).with("a/k.rb").and_return(false)<br />
expect(participant.files("a")).to eq(["a/k.rb"])<br />
end<br />
end<br />
<br />
context 'when there is subdirectory in current directory' do<br />
it 'recursively returns all files in current directory' do<br />
allow(Dir).to receive(:[]).with("a/*").and_return(["a/b"])<br />
allow(File).to receive(:directory?).with("a/b").and_return(true)<br />
allow(Dir).to receive(:[]).with("a/b/*").and_return(["a/b/k.rb"])<br />
allow(File).to receive(:directory?).with("a/b/k.rb").and_return(false)<br />
expect(participant.files("a")).to eq(["a/b/k.rb", "a/b"])<br />
end<br />
end<br />
end<br />
<br />
describe ".import" do<br />
context 'when record is empty' do<br />
it 'raises an ArgumentError' do<br />
row = []<br />
allow(AssignmentParticipant).to receive(:check_info_and_create).with(any_args).and_raise("No user id has been specified.")<br />
expect(AssignmentParticipant).to receive(:check_info_and_create)<br />
expect { AssignmentParticipant.import(row, nil, nil, nil) }.to raise_error("No user id has been specified.")<br />
end<br />
end<br />
<br />
context 'when no user is found by offered username' do<br />
context 'when the record has less than 4 items' do<br />
it 'raises an ArgumentError' do<br />
row = ["user_name", "user_fullname", "name@email.com"]<br />
allow(AssignmentParticipant).<br />
to receive(:check_info_and_create).with(any_args).and_raise("The record containing #{row[0]} does not have enough items.")<br />
expect(AssignmentParticipant).to receive(:check_info_and_create)<br />
expect { AssignmentParticipant.import(row, nil, nil, nil) }.to raise_error("The record containing #{row[0]} does not have enough items.")<br />
end<br />
end<br />
<br />
context 'when the record has more than 4 items' do<br />
context 'when certain assignment cannot be found' do<br />
it 'creates a new user based on import information and raises an ImportError' do<br />
row = ["user_name", "user_fullname", "name@email.com", "user_role_name", "user_parent_name"]<br />
session = {user: participant}<br />
allow(User).to receive(:find_by).with(any_args).and_return(nil)<br />
allow(Assignment).to receive(:find).with(2).and_return(nil)<br />
expect { AssignmentParticipant.import(row, nil, session, 2) }.<br />
to raise_error("The assignment with id \"2\" was not found.").and change { User.count }.by(1)<br />
end<br />
end<br />
<br />
context 'when certain assignment can be found and assignment participant does not exists' do<br />
it 'creates a new user, new participant and raises an ImportError' do<br />
row = ["user_name", "user_fullname", "name@email.com", "user_role_name", "user_parent_name"]<br />
session = {user: participant}<br />
allow(User).to receive(:find_by_name).with(any_args).and_return(nil)<br />
allow(Assignment).to receive(:find).with(2).and_return(assignment)<br />
allow(AssignmentParticipant).to receive(:exists?).and_return(false)<br />
expect { AssignmentParticipant.import(row, nil, session, 2) }.to change { User.count }.by(1).and change { AssignmentParticipant.count }.by(1)<br />
end<br />
end<br />
end<br />
end<br />
end<br />
<br />
describe '.export' do<br />
it 'exports all participants in current assignment' do<br />
csv = []<br />
expect(AssignmentParticipant).to receive_message_chain(:where, :find_each).with(any_args).and_yield(participant)<br />
expect(AssignmentParticipant.export(csv, 1, any_args)).<br />
to eq([["student2064", "2064, student", "expertiza@mailinator.com", "Student", "instructor6", true, true, true, "handle"]])<br />
end<br />
end<br />
<br />
describe '#set_handle' do<br />
context 'when the user of current participant does not have handle' do<br />
it 'sets the user name as the handle of current participant' do<br />
allow(student).to receive_message_chain(:handle, :nil?).and_return(true)<br />
allow(student).to receive(:handle).and_return("")<br />
participant.set_handle<br />
expect(participant.handle).to eq("student2064")<br />
end<br />
end<br />
<br />
context 'when current assignment exists participants with same handle as the one of current user' do<br />
it 'sets the user name as the name of current participant' do<br />
allow(AssignmentParticipant).to receive(:exists?).with(any_args).and_return(true)<br />
participant.set_handle<br />
expect(participant.handle).to eq("student2064")<br />
end<br />
end<br />
<br />
context 'when current assignment does not have participants with same handle as the one of current user' do<br />
it 'sets the user name as the handle of current participant' do<br />
participant.set_handle<br />
expect(participant.handle).to eq("handle")<br />
end<br />
end<br />
end<br />
<br />
describe '#review_file_path' do<br />
it 'returns the file path for reviewer to upload files during peer review' do<br />
allow(ResponseMap).to receive(:find).with(any_args).and_return(response_map)<br />
allow(TeamsUser).to receive_message_chain(:find_by, :user_id).with(any_args).and_return(1)<br />
allow(Participant).to receive(:find_by).with(any_args).and_return(participant)<br />
file_path = Rails.root.to_s + "/pg_data/instructor6/csc517/test/final_test/0_review/1"<br />
expect(participant.review_file_path(1)).to eq(file_path)<br />
end<br />
end<br />
<br />
describe '#current_stage' do<br />
it 'returns stage of current assignment' do<br />
allow(assignment).to receive(:get_current_stage).with(1).and_return("Finished")<br />
expect(participant.current_stage).to eq("Finished")<br />
end<br />
end<br />
<br />
describe '#stage_deadline' do<br />
context 'when stage of current assignment is not Finished' do<br />
it 'returns current stage' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Unknow")<br />
expect(participant.stage_deadline).to eq("Unknow")<br />
end<br />
end<br />
<br />
context 'when stage of current assignment not Finished' do<br />
context 'current assignment is not a staggered deadline assignment' do<br />
it 'returns the due date of current assignment' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Finished")<br />
allow(assignment).to receive(:staggered_deadline?).and_return(false)<br />
allow(assignment).to receive_message_chain(:due_dates, :last, :due_at).and_return(1)<br />
expect(participant.stage_deadline).to eq("1")<br />
end<br />
end<br />
<br />
context 'current assignment is a staggered deadline assignment' do<br />
it 'returns the due date of current topic' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Finished")<br />
allow(assignment).to receive(:staggered_deadline?).and_return(true)<br />
allow(TopicDueDate).to receive_message_chain(:find_by, :last, :due_at).and_return(1)<br />
expect(participant.stage_deadline).to eq("1")<br />
end<br />
end<br />
end<br />
end<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===Files method===<br />
The files method of AssignmentParticipant model is exactly the same as '''assignment_team.rb, L103''', so we move it to a module named Instance_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and AssignmentTeam model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Instance_method<br />
<br />
* module Instance_method<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = []<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each {|f| files << f }<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
===Self.import method===<br />
The self.import method of AssignmentParticipant model is exactly the same as '''course_participant.rb, L21''', so we move it to a module named Class_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and CourseParticipant model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Class_method<br />
<br />
def self.import(row, _row_header = nil, session, id)<br />
user = AssignmentParticipant.check_info_and_create(row, _row_header = nil, session)<br />
raise ImportError, "The assignment with id \"" + id.to_s + "\" was not found." if Assignment.find(id).nil?<br />
unless AssignmentParticipant.exists?(user_id: user.id, parent_id: id)<br />
new_part = AssignmentParticipant.create(user_id: user.id, parent_id: id)<br />
new_part.set_handle<br />
end<br />
end<br />
<br />
* module Class_method<br />
def check_info_and_create(row, _row_header = nil, session)<br />
raise ArgumentError, "No user id has been specified." if row.empty?<br />
user = User.find_by(name: row[0])<br />
if user.nil?<br />
raise ArgumentError, "The record containing #{row[0]} does not have enough items." if row.length < 4<br />
attributes = ImportFileHelper.define_attributes(row)<br />
user = ImportFileHelper.create_new_user(attributes, session)<br />
end<br />
end<br />
<br />
===Find_by method===<br />
Use '''find_by''' instead of dynamic method<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by(name:row[0])<br />
|-<br />
|}<br />
<br />
Use '''find_by''' instead of where.first<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109702CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T04:10:15Z<p>Cshao: /* Test */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at using TFD(Test First Development) to refactor the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc.<br />
<br />
We used the TDF(Test First Development) method to refactor the AssignmentParticipant model. With the RSpec tool, we wrote 38 test cases for 24 methods in '''assignment_participant_spec.rb''' first. After finishing these test cases, we executed them, and most of them failed. And then we refactored the methods, '''scores''', '''files''', '''self.import''', '''find_by''', '''where.first''', and executed the test cases again, finally they all passed.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
== Test ==<br />
Because the project is aimed at using TFD(Test First Development) to refactor the AssignmentParticipant model.<br />
We wrote 38 test cases for 24 methods in '''assignment_participant_spec.rb''' first, with the RSpec tool.<br />
Introduction video to our project<ref>Introduction video to our project https://www.youtube.com/watch?v=sJdmN-S2Voo&feature=youtu.be</ref><br />
describe '#dir_path' do<br />
it 'returns the directory path of current assignment' do<br />
expect(participant.dir_path).to eq "final_test"<br />
end<br />
end<br />
<br />
describe '#assign_quiz' do<br />
it 'creates a new QuizResponseMap record' do<br />
allow(QuizQuestionnaire).to receive(:find_by).with(instructor_id: 1).and_return(quiz_questionaire) # WHY CAN NOT DELETE THIS SENTENCE<br />
expect { participant.assign_quiz(participant, participant2, nil) }.to change { QuizResponseMap.count }.from(0).to(1)<br />
expect(participant.assign_quiz(participant, participant2, nil)).to be_an_instance_of(QuizResponseMap)<br />
end<br />
end<br />
<br />
describe '#reviewers' do<br />
it 'returns all the participants in this assignment who have reviewed the team where this participant belongs' do<br />
allow(ReviewResponseMap).to receive(:where).with(any_args).and_return([response_map]) # differences with .with(parameter)<br />
allow(AssignmentParticipant).to receive(:find).with(any_args).and_return(participant2)<br />
expect(participant.reviewers).to eq([participant2])<br />
end<br />
end<br />
<br />
describe '#review_score' do<br />
it 'returns the review score' do<br />
# diao yong de method tai duo le,er qie bu zhi dao sha yi si<br />
allow(review_questionnaire).to receive(:get_assessments_for).with(any_args).and_return([response])<br />
allow(review_questionnaire).to receive(:questions).and_return(question)<br />
allow(Answer).to receive(:compute_scores).with([response], question).and_return(avg: 100)<br />
allow(review_questionnaire).to receive(:max_possible_score).and_return(100)<br />
expect(participant.review_score).to eq(100)<br />
end<br />
end<br />
<br />
describe '#scores' do<br />
context 'when assignment is not varying rubric by round and not an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(false)<br />
allow(assignment).to receive(:is_microtask?).and_return(false)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
<br />
context 'when assignment is varying rubric by round but not an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(true)<br />
expect(participant).to receive(:merge_scores)<br />
allow(assignment).to receive(:is_microtask?).and_return(false)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
<br />
context 'when assignment is not varying rubric by round but an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(false)<br />
allow(assignment).to receive(:is_microtask?).and_return(true)<br />
expect(participant).to receive(:topic_total_scores)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
end<br />
<br />
# included method<br />
describe '#assignment_questionnaires' do<br />
context 'when the round of questionnaire is nil' do<br />
it 'record the result as review scores' do<br />
scores = {}<br />
question_hash = {review: question}<br />
score_map = {max: 100, min: 100, avg: 100}<br />
allow(AssignmentQuestionnaire).to receive(:find_by).with(any_args).and_return(assignment_questionnaire)<br />
allow(review_questionnaire).to receive(:get_assessments_for).with(any_args).and_return([response])<br />
allow(Answer).to receive(:compute_scores).with(any_args).and_return(score_map)<br />
participant.assignment_questionnaires(question_hash, scores)<br />
expect(scores[:review][:assessments]).to eq([response])<br />
expect(scores[:review][:scores]).to eq(score_map)<br />
end<br />
end<br />
<br />
context 'when the round of questionnaire is not nil' do<br />
it 'record the result as review#{n} scores' do<br />
scores = {}<br />
question_hash = {review1: question}<br />
score_map = {max: 100, min: 100, avg: 100}<br />
allow(AssignmentQuestionnaire).to receive(:find_by).and_return(assignment_questionnaire2)<br />
allow(review_questionnaire).to receive(:get_assessments_round_for).with(any_args).and_return([response])<br />
allow(Answer).to receive(:compute_scores).with(any_args).and_return(score_map)<br />
participant.assignment_questionnaires(question_hash, scores)<br />
expect(scores[:review1][:assessments]).to eq([response])<br />
expect(scores[:review1][:scores]).to eq(score_map)<br />
end<br />
end<br />
end<br />
<br />
describe '#merge_scores' do<br />
context 'when all of the review_n are nil' do<br />
it 'set max, min, avg of review score as 0' do<br />
scores = {}<br />
allow(assignment).to receive(:num_review_rounds).and_return(1)<br />
participant.merge_scores(scores)<br />
expect(scores[:review][:scores][:max]).to eq(0)<br />
expect(scores[:review][:scores][:min]).to eq(0)<br />
expect(scores[:review][:scores][:min]).to eq(0)<br />
end<br />
end<br />
<br />
context 'when the review_n is not nil' do<br />
it 'merge the score of review_n to the score of review' do<br />
score_map = {max: 100, min: 100, avg: 100}<br />
scores = {review1: {scores: score_map, assessments: [response]}}<br />
allow(assignment).to receive(:num_review_rounds).and_return(1)<br />
participant.merge_scores(scores)<br />
expect(scores[:review][:scores][:max]).to eq(100)<br />
expect(scores[:review][:scores][:min]).to eq(100)<br />
expect(scores[:review][:scores][:min]).to eq(100)<br />
end<br />
end<br />
end<br />
<br />
describe '#topic_total_scores' do<br />
it 'set total_score and max_pts_available of score when topic is not nil' do<br />
scores = {total_score: 100}<br />
allow(SignUpTopic).to receive(:find_by).with(any_args).and_return(topic)<br />
participant.topic_total_scores(scores)<br />
expect(scores[:total_score]).to eq(0)<br />
expect(scores[:max_pts_available]).to eq(0)<br />
end<br />
end<br />
<br />
describe '#caculate_scores' do<br />
context 'when the participant has the grade' do<br />
it 'his total scores equals his grade' do<br />
scores = {}<br />
expect(participant2.caculate_scores(scores)).to eq(100.0)<br />
end<br />
end<br />
context 'when the participant has the grade and the total score more than 100' do<br />
it 'return the score of a given participant with total score 100' do<br />
scores = {total_score: 110}<br />
expect(participant.caculate_scores(scores)).to eq(total_score: 100)<br />
end<br />
end<br />
context 'when the participant has the grade and the total score less than 100' do<br />
it 'return the score of a given participant with total score' do<br />
scores = {total_score: 90}<br />
expect(participant.caculate_scores(scores)).to eq(total_score: 90)<br />
end<br />
end<br />
end<br />
<br />
describe '#copy' do<br />
it 'copies assignment participants to a certain course' do<br />
expect(participant.copy(517)).to be_an_instance_of(CourseParticipant)<br />
end<br />
end<br />
<br />
describe '#feedback' do<br />
it 'returns corrsponding author feedback responses given by current participant' do<br />
expect(participant.feedback).to eq([response])<br />
end<br />
end<br />
<br />
describe '#reviews' do<br />
it 'returns corrsponding peer review responses given by current team' do<br />
expect(participant.reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#reviews_by_reviewer' do<br />
it 'returns corrsponding peer review responses given by certain reviewer' do<br />
allow(ReviewResponseMap).to receive(:get_reviewer_assessments_for).with(team, participant2).and_return([response])<br />
expect(participant.reviews_by_reviewer(participant2)).to eq([response])<br />
end<br />
end<br />
<br />
describe '#quizzes_taken' do<br />
it 'returns corrsponding quiz responses given by current participant' do<br />
expect(participant.quizzes_taken).to eq([response])<br />
end<br />
end<br />
<br />
describe '#metareviews' do<br />
it 'returns corrsponding metareview responses given by current participant' do<br />
expect(participant.metareviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#teammate_reviews' do<br />
it 'returns corrsponding teammate review responses given by current participant' do<br />
expect(participant.teammate_reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#bookmark_reviews' do<br />
it 'returns corrsponding bookmark review responses given by current participant' do<br />
expect(participant.bookmark_reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#files' do<br />
context 'when there is not subdirectory in current directory' do<br />
it 'returns all files in current directory' do<br />
allow(Dir).to receive(:[]).with("a/*").and_return(["a/k.rb"])<br />
allow(File).to receive(:directory?).with("a/k.rb").and_return(false)<br />
expect(participant.files("a")).to eq(["a/k.rb"])<br />
end<br />
end<br />
<br />
context 'when there is subdirectory in current directory' do<br />
it 'recursively returns all files in current directory' do<br />
allow(Dir).to receive(:[]).with("a/*").and_return(["a/b"])<br />
allow(File).to receive(:directory?).with("a/b").and_return(true)<br />
allow(Dir).to receive(:[]).with("a/b/*").and_return(["a/b/k.rb"])<br />
allow(File).to receive(:directory?).with("a/b/k.rb").and_return(false)<br />
expect(participant.files("a")).to eq(["a/b/k.rb", "a/b"])<br />
end<br />
end<br />
end<br />
<br />
describe ".import" do<br />
context 'when record is empty' do<br />
it 'raises an ArgumentError' do<br />
row = []<br />
allow(AssignmentParticipant).to receive(:check_info_and_create).with(any_args).and_raise("No user id has been specified.")<br />
expect(AssignmentParticipant).to receive(:check_info_and_create)<br />
expect { AssignmentParticipant.import(row, nil, nil, nil) }.to raise_error("No user id has been specified.")<br />
end<br />
end<br />
<br />
context 'when no user is found by offered username' do<br />
context 'when the record has less than 4 items' do<br />
it 'raises an ArgumentError' do<br />
row = ["user_name", "user_fullname", "name@email.com"]<br />
allow(AssignmentParticipant).<br />
to receive(:check_info_and_create).with(any_args).and_raise("The record containing #{row[0]} does not have enough items.")<br />
expect(AssignmentParticipant).to receive(:check_info_and_create)<br />
expect { AssignmentParticipant.import(row, nil, nil, nil) }.to raise_error("The record containing #{row[0]} does not have enough items.")<br />
end<br />
end<br />
<br />
context 'when the record has more than 4 items' do<br />
context 'when certain assignment cannot be found' do<br />
it 'creates a new user based on import information and raises an ImportError' do<br />
row = ["user_name", "user_fullname", "name@email.com", "user_role_name", "user_parent_name"]<br />
session = {user: participant}<br />
allow(User).to receive(:find_by).with(any_args).and_return(nil)<br />
allow(Assignment).to receive(:find).with(2).and_return(nil)<br />
expect { AssignmentParticipant.import(row, nil, session, 2) }.<br />
to raise_error("The assignment with id \"2\" was not found.").and change { User.count }.by(1)<br />
end<br />
end<br />
<br />
context 'when certain assignment can be found and assignment participant does not exists' do<br />
it 'creates a new user, new participant and raises an ImportError' do<br />
row = ["user_name", "user_fullname", "name@email.com", "user_role_name", "user_parent_name"]<br />
session = {user: participant}<br />
allow(User).to receive(:find_by_name).with(any_args).and_return(nil)<br />
allow(Assignment).to receive(:find).with(2).and_return(assignment)<br />
allow(AssignmentParticipant).to receive(:exists?).and_return(false)<br />
expect { AssignmentParticipant.import(row, nil, session, 2) }.to change { User.count }.by(1).and change { AssignmentParticipant.count }.by(1)<br />
end<br />
end<br />
end<br />
end<br />
end<br />
<br />
describe '.export' do<br />
it 'exports all participants in current assignment' do<br />
csv = []<br />
expect(AssignmentParticipant).to receive_message_chain(:where, :find_each).with(any_args).and_yield(participant)<br />
expect(AssignmentParticipant.export(csv, 1, any_args)).<br />
to eq([["student2064", "2064, student", "expertiza@mailinator.com", "Student", "instructor6", true, true, true, "handle"]])<br />
end<br />
end<br />
<br />
describe '#set_handle' do<br />
context 'when the user of current participant does not have handle' do<br />
it 'sets the user name as the handle of current participant' do<br />
allow(student).to receive_message_chain(:handle, :nil?).and_return(true)<br />
allow(student).to receive(:handle).and_return("")<br />
participant.set_handle<br />
expect(participant.handle).to eq("student2064")<br />
end<br />
end<br />
<br />
context 'when current assignment exists participants with same handle as the one of current user' do<br />
it 'sets the user name as the name of current participant' do<br />
allow(AssignmentParticipant).to receive(:exists?).with(any_args).and_return(true)<br />
participant.set_handle<br />
expect(participant.handle).to eq("student2064")<br />
end<br />
end<br />
<br />
context 'when current assignment does not have participants with same handle as the one of current user' do<br />
it 'sets the user name as the handle of current participant' do<br />
participant.set_handle<br />
expect(participant.handle).to eq("handle")<br />
end<br />
end<br />
end<br />
<br />
describe '#review_file_path' do<br />
it 'returns the file path for reviewer to upload files during peer review' do<br />
allow(ResponseMap).to receive(:find).with(any_args).and_return(response_map)<br />
allow(TeamsUser).to receive_message_chain(:find_by, :user_id).with(any_args).and_return(1)<br />
allow(Participant).to receive(:find_by).with(any_args).and_return(participant)<br />
file_path = Rails.root.to_s + "/pg_data/instructor6/csc517/test/final_test/0_review/1"<br />
expect(participant.review_file_path(1)).to eq(file_path)<br />
end<br />
end<br />
<br />
describe '#current_stage' do<br />
it 'returns stage of current assignment' do<br />
allow(assignment).to receive(:get_current_stage).with(1).and_return("Finished")<br />
expect(participant.current_stage).to eq("Finished")<br />
end<br />
end<br />
<br />
describe '#stage_deadline' do<br />
context 'when stage of current assignment is not Finished' do<br />
it 'returns current stage' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Unknow")<br />
expect(participant.stage_deadline).to eq("Unknow")<br />
end<br />
end<br />
<br />
context 'when stage of current assignment not Finished' do<br />
context 'current assignment is not a staggered deadline assignment' do<br />
it 'returns the due date of current assignment' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Finished")<br />
allow(assignment).to receive(:staggered_deadline?).and_return(false)<br />
allow(assignment).to receive_message_chain(:due_dates, :last, :due_at).and_return(1)<br />
expect(participant.stage_deadline).to eq("1")<br />
end<br />
end<br />
<br />
context 'current assignment is a staggered deadline assignment' do<br />
it 'returns the due date of current topic' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Finished")<br />
allow(assignment).to receive(:staggered_deadline?).and_return(true)<br />
allow(TopicDueDate).to receive_message_chain(:find_by, :last, :due_at).and_return(1)<br />
expect(participant.stage_deadline).to eq("1")<br />
end<br />
end<br />
end<br />
end<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===Files method===<br />
The files method of AssignmentParticipant model is exactly the same as '''assignment_team.rb, L103''', so we move it to a module named Instance_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and AssignmentTeam model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Instance_method<br />
<br />
* module Instance_method<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = []<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each {|f| files << f }<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
===Self.import method===<br />
The self.import method of AssignmentParticipant model is exactly the same as '''course_participant.rb, L21''', so we move it to a module named Class_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and CourseParticipant model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Class_method<br />
<br />
def self.import(row, _row_header = nil, session, id)<br />
user = AssignmentParticipant.check_info_and_create(row, _row_header = nil, session)<br />
raise ImportError, "The assignment with id \"" + id.to_s + "\" was not found." if Assignment.find(id).nil?<br />
unless AssignmentParticipant.exists?(user_id: user.id, parent_id: id)<br />
new_part = AssignmentParticipant.create(user_id: user.id, parent_id: id)<br />
new_part.set_handle<br />
end<br />
end<br />
<br />
* module Class_method<br />
def check_info_and_create(row, _row_header = nil, session)<br />
raise ArgumentError, "No user id has been specified." if row.empty?<br />
user = User.find_by(name: row[0])<br />
if user.nil?<br />
raise ArgumentError, "The record containing #{row[0]} does not have enough items." if row.length < 4<br />
attributes = ImportFileHelper.define_attributes(row)<br />
user = ImportFileHelper.create_new_user(attributes, session)<br />
end<br />
end<br />
<br />
===Find_by method===<br />
Use '''find_by''' instead of dynamic method<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by(name:row[0])<br />
|-<br />
|}<br />
<br />
Use '''find_by''' instead of where.first<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109701CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T04:09:21Z<p>Cshao: </p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at using TFD(Test First Development) to refactor the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc.<br />
<br />
We used the TDF(Test First Development) method to refactor the AssignmentParticipant model. With the RSpec tool, we wrote 38 test cases for 24 methods in '''assignment_participant_spec.rb''' first. After finishing these test cases, we executed them, and most of them failed. And then we refactored the methods, '''scores''', '''files''', '''self.import''', '''find_by''', '''where.first''', and executed the test cases again, finally they all passed.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
== Test ==<br />
Because the project is aimed at using TFD(Test First Development) to refactor the AssignmentParticipant model.<br />
We wrote 38 test cases for 24 methods in '''assignment_participant_spec.rb''' first, with the RSpec tool.<br />
<ref>Introduction video to our project https://www.youtube.com/watch?v=sJdmN-S2Voo&feature=youtu.be</ref><br />
describe '#dir_path' do<br />
it 'returns the directory path of current assignment' do<br />
expect(participant.dir_path).to eq "final_test"<br />
end<br />
end<br />
<br />
describe '#assign_quiz' do<br />
it 'creates a new QuizResponseMap record' do<br />
allow(QuizQuestionnaire).to receive(:find_by).with(instructor_id: 1).and_return(quiz_questionaire) # WHY CAN NOT DELETE THIS SENTENCE<br />
expect { participant.assign_quiz(participant, participant2, nil) }.to change { QuizResponseMap.count }.from(0).to(1)<br />
expect(participant.assign_quiz(participant, participant2, nil)).to be_an_instance_of(QuizResponseMap)<br />
end<br />
end<br />
<br />
describe '#reviewers' do<br />
it 'returns all the participants in this assignment who have reviewed the team where this participant belongs' do<br />
allow(ReviewResponseMap).to receive(:where).with(any_args).and_return([response_map]) # differences with .with(parameter)<br />
allow(AssignmentParticipant).to receive(:find).with(any_args).and_return(participant2)<br />
expect(participant.reviewers).to eq([participant2])<br />
end<br />
end<br />
<br />
describe '#review_score' do<br />
it 'returns the review score' do<br />
# diao yong de method tai duo le,er qie bu zhi dao sha yi si<br />
allow(review_questionnaire).to receive(:get_assessments_for).with(any_args).and_return([response])<br />
allow(review_questionnaire).to receive(:questions).and_return(question)<br />
allow(Answer).to receive(:compute_scores).with([response], question).and_return(avg: 100)<br />
allow(review_questionnaire).to receive(:max_possible_score).and_return(100)<br />
expect(participant.review_score).to eq(100)<br />
end<br />
end<br />
<br />
describe '#scores' do<br />
context 'when assignment is not varying rubric by round and not an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(false)<br />
allow(assignment).to receive(:is_microtask?).and_return(false)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
<br />
context 'when assignment is varying rubric by round but not an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(true)<br />
expect(participant).to receive(:merge_scores)<br />
allow(assignment).to receive(:is_microtask?).and_return(false)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
<br />
context 'when assignment is not varying rubric by round but an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(false)<br />
allow(assignment).to receive(:is_microtask?).and_return(true)<br />
expect(participant).to receive(:topic_total_scores)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
end<br />
<br />
# included method<br />
describe '#assignment_questionnaires' do<br />
context 'when the round of questionnaire is nil' do<br />
it 'record the result as review scores' do<br />
scores = {}<br />
question_hash = {review: question}<br />
score_map = {max: 100, min: 100, avg: 100}<br />
allow(AssignmentQuestionnaire).to receive(:find_by).with(any_args).and_return(assignment_questionnaire)<br />
allow(review_questionnaire).to receive(:get_assessments_for).with(any_args).and_return([response])<br />
allow(Answer).to receive(:compute_scores).with(any_args).and_return(score_map)<br />
participant.assignment_questionnaires(question_hash, scores)<br />
expect(scores[:review][:assessments]).to eq([response])<br />
expect(scores[:review][:scores]).to eq(score_map)<br />
end<br />
end<br />
<br />
context 'when the round of questionnaire is not nil' do<br />
it 'record the result as review#{n} scores' do<br />
scores = {}<br />
question_hash = {review1: question}<br />
score_map = {max: 100, min: 100, avg: 100}<br />
allow(AssignmentQuestionnaire).to receive(:find_by).and_return(assignment_questionnaire2)<br />
allow(review_questionnaire).to receive(:get_assessments_round_for).with(any_args).and_return([response])<br />
allow(Answer).to receive(:compute_scores).with(any_args).and_return(score_map)<br />
participant.assignment_questionnaires(question_hash, scores)<br />
expect(scores[:review1][:assessments]).to eq([response])<br />
expect(scores[:review1][:scores]).to eq(score_map)<br />
end<br />
end<br />
end<br />
<br />
describe '#merge_scores' do<br />
context 'when all of the review_n are nil' do<br />
it 'set max, min, avg of review score as 0' do<br />
scores = {}<br />
allow(assignment).to receive(:num_review_rounds).and_return(1)<br />
participant.merge_scores(scores)<br />
expect(scores[:review][:scores][:max]).to eq(0)<br />
expect(scores[:review][:scores][:min]).to eq(0)<br />
expect(scores[:review][:scores][:min]).to eq(0)<br />
end<br />
end<br />
<br />
context 'when the review_n is not nil' do<br />
it 'merge the score of review_n to the score of review' do<br />
score_map = {max: 100, min: 100, avg: 100}<br />
scores = {review1: {scores: score_map, assessments: [response]}}<br />
allow(assignment).to receive(:num_review_rounds).and_return(1)<br />
participant.merge_scores(scores)<br />
expect(scores[:review][:scores][:max]).to eq(100)<br />
expect(scores[:review][:scores][:min]).to eq(100)<br />
expect(scores[:review][:scores][:min]).to eq(100)<br />
end<br />
end<br />
end<br />
<br />
describe '#topic_total_scores' do<br />
it 'set total_score and max_pts_available of score when topic is not nil' do<br />
scores = {total_score: 100}<br />
allow(SignUpTopic).to receive(:find_by).with(any_args).and_return(topic)<br />
participant.topic_total_scores(scores)<br />
expect(scores[:total_score]).to eq(0)<br />
expect(scores[:max_pts_available]).to eq(0)<br />
end<br />
end<br />
<br />
describe '#caculate_scores' do<br />
context 'when the participant has the grade' do<br />
it 'his total scores equals his grade' do<br />
scores = {}<br />
expect(participant2.caculate_scores(scores)).to eq(100.0)<br />
end<br />
end<br />
context 'when the participant has the grade and the total score more than 100' do<br />
it 'return the score of a given participant with total score 100' do<br />
scores = {total_score: 110}<br />
expect(participant.caculate_scores(scores)).to eq(total_score: 100)<br />
end<br />
end<br />
context 'when the participant has the grade and the total score less than 100' do<br />
it 'return the score of a given participant with total score' do<br />
scores = {total_score: 90}<br />
expect(participant.caculate_scores(scores)).to eq(total_score: 90)<br />
end<br />
end<br />
end<br />
<br />
describe '#copy' do<br />
it 'copies assignment participants to a certain course' do<br />
expect(participant.copy(517)).to be_an_instance_of(CourseParticipant)<br />
end<br />
end<br />
<br />
describe '#feedback' do<br />
it 'returns corrsponding author feedback responses given by current participant' do<br />
expect(participant.feedback).to eq([response])<br />
end<br />
end<br />
<br />
describe '#reviews' do<br />
it 'returns corrsponding peer review responses given by current team' do<br />
expect(participant.reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#reviews_by_reviewer' do<br />
it 'returns corrsponding peer review responses given by certain reviewer' do<br />
allow(ReviewResponseMap).to receive(:get_reviewer_assessments_for).with(team, participant2).and_return([response])<br />
expect(participant.reviews_by_reviewer(participant2)).to eq([response])<br />
end<br />
end<br />
<br />
describe '#quizzes_taken' do<br />
it 'returns corrsponding quiz responses given by current participant' do<br />
expect(participant.quizzes_taken).to eq([response])<br />
end<br />
end<br />
<br />
describe '#metareviews' do<br />
it 'returns corrsponding metareview responses given by current participant' do<br />
expect(participant.metareviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#teammate_reviews' do<br />
it 'returns corrsponding teammate review responses given by current participant' do<br />
expect(participant.teammate_reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#bookmark_reviews' do<br />
it 'returns corrsponding bookmark review responses given by current participant' do<br />
expect(participant.bookmark_reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#files' do<br />
context 'when there is not subdirectory in current directory' do<br />
it 'returns all files in current directory' do<br />
allow(Dir).to receive(:[]).with("a/*").and_return(["a/k.rb"])<br />
allow(File).to receive(:directory?).with("a/k.rb").and_return(false)<br />
expect(participant.files("a")).to eq(["a/k.rb"])<br />
end<br />
end<br />
<br />
context 'when there is subdirectory in current directory' do<br />
it 'recursively returns all files in current directory' do<br />
allow(Dir).to receive(:[]).with("a/*").and_return(["a/b"])<br />
allow(File).to receive(:directory?).with("a/b").and_return(true)<br />
allow(Dir).to receive(:[]).with("a/b/*").and_return(["a/b/k.rb"])<br />
allow(File).to receive(:directory?).with("a/b/k.rb").and_return(false)<br />
expect(participant.files("a")).to eq(["a/b/k.rb", "a/b"])<br />
end<br />
end<br />
end<br />
<br />
describe ".import" do<br />
context 'when record is empty' do<br />
it 'raises an ArgumentError' do<br />
row = []<br />
allow(AssignmentParticipant).to receive(:check_info_and_create).with(any_args).and_raise("No user id has been specified.")<br />
expect(AssignmentParticipant).to receive(:check_info_and_create)<br />
expect { AssignmentParticipant.import(row, nil, nil, nil) }.to raise_error("No user id has been specified.")<br />
end<br />
end<br />
<br />
context 'when no user is found by offered username' do<br />
context 'when the record has less than 4 items' do<br />
it 'raises an ArgumentError' do<br />
row = ["user_name", "user_fullname", "name@email.com"]<br />
allow(AssignmentParticipant).<br />
to receive(:check_info_and_create).with(any_args).and_raise("The record containing #{row[0]} does not have enough items.")<br />
expect(AssignmentParticipant).to receive(:check_info_and_create)<br />
expect { AssignmentParticipant.import(row, nil, nil, nil) }.to raise_error("The record containing #{row[0]} does not have enough items.")<br />
end<br />
end<br />
<br />
context 'when the record has more than 4 items' do<br />
context 'when certain assignment cannot be found' do<br />
it 'creates a new user based on import information and raises an ImportError' do<br />
row = ["user_name", "user_fullname", "name@email.com", "user_role_name", "user_parent_name"]<br />
session = {user: participant}<br />
allow(User).to receive(:find_by).with(any_args).and_return(nil)<br />
allow(Assignment).to receive(:find).with(2).and_return(nil)<br />
expect { AssignmentParticipant.import(row, nil, session, 2) }.<br />
to raise_error("The assignment with id \"2\" was not found.").and change { User.count }.by(1)<br />
end<br />
end<br />
<br />
context 'when certain assignment can be found and assignment participant does not exists' do<br />
it 'creates a new user, new participant and raises an ImportError' do<br />
row = ["user_name", "user_fullname", "name@email.com", "user_role_name", "user_parent_name"]<br />
session = {user: participant}<br />
allow(User).to receive(:find_by_name).with(any_args).and_return(nil)<br />
allow(Assignment).to receive(:find).with(2).and_return(assignment)<br />
allow(AssignmentParticipant).to receive(:exists?).and_return(false)<br />
expect { AssignmentParticipant.import(row, nil, session, 2) }.to change { User.count }.by(1).and change { AssignmentParticipant.count }.by(1)<br />
end<br />
end<br />
end<br />
end<br />
end<br />
<br />
describe '.export' do<br />
it 'exports all participants in current assignment' do<br />
csv = []<br />
expect(AssignmentParticipant).to receive_message_chain(:where, :find_each).with(any_args).and_yield(participant)<br />
expect(AssignmentParticipant.export(csv, 1, any_args)).<br />
to eq([["student2064", "2064, student", "expertiza@mailinator.com", "Student", "instructor6", true, true, true, "handle"]])<br />
end<br />
end<br />
<br />
describe '#set_handle' do<br />
context 'when the user of current participant does not have handle' do<br />
it 'sets the user name as the handle of current participant' do<br />
allow(student).to receive_message_chain(:handle, :nil?).and_return(true)<br />
allow(student).to receive(:handle).and_return("")<br />
participant.set_handle<br />
expect(participant.handle).to eq("student2064")<br />
end<br />
end<br />
<br />
context 'when current assignment exists participants with same handle as the one of current user' do<br />
it 'sets the user name as the name of current participant' do<br />
allow(AssignmentParticipant).to receive(:exists?).with(any_args).and_return(true)<br />
participant.set_handle<br />
expect(participant.handle).to eq("student2064")<br />
end<br />
end<br />
<br />
context 'when current assignment does not have participants with same handle as the one of current user' do<br />
it 'sets the user name as the handle of current participant' do<br />
participant.set_handle<br />
expect(participant.handle).to eq("handle")<br />
end<br />
end<br />
end<br />
<br />
describe '#review_file_path' do<br />
it 'returns the file path for reviewer to upload files during peer review' do<br />
allow(ResponseMap).to receive(:find).with(any_args).and_return(response_map)<br />
allow(TeamsUser).to receive_message_chain(:find_by, :user_id).with(any_args).and_return(1)<br />
allow(Participant).to receive(:find_by).with(any_args).and_return(participant)<br />
file_path = Rails.root.to_s + "/pg_data/instructor6/csc517/test/final_test/0_review/1"<br />
expect(participant.review_file_path(1)).to eq(file_path)<br />
end<br />
end<br />
<br />
describe '#current_stage' do<br />
it 'returns stage of current assignment' do<br />
allow(assignment).to receive(:get_current_stage).with(1).and_return("Finished")<br />
expect(participant.current_stage).to eq("Finished")<br />
end<br />
end<br />
<br />
describe '#stage_deadline' do<br />
context 'when stage of current assignment is not Finished' do<br />
it 'returns current stage' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Unknow")<br />
expect(participant.stage_deadline).to eq("Unknow")<br />
end<br />
end<br />
<br />
context 'when stage of current assignment not Finished' do<br />
context 'current assignment is not a staggered deadline assignment' do<br />
it 'returns the due date of current assignment' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Finished")<br />
allow(assignment).to receive(:staggered_deadline?).and_return(false)<br />
allow(assignment).to receive_message_chain(:due_dates, :last, :due_at).and_return(1)<br />
expect(participant.stage_deadline).to eq("1")<br />
end<br />
end<br />
<br />
context 'current assignment is a staggered deadline assignment' do<br />
it 'returns the due date of current topic' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Finished")<br />
allow(assignment).to receive(:staggered_deadline?).and_return(true)<br />
allow(TopicDueDate).to receive_message_chain(:find_by, :last, :due_at).and_return(1)<br />
expect(participant.stage_deadline).to eq("1")<br />
end<br />
end<br />
end<br />
end<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===Files method===<br />
The files method of AssignmentParticipant model is exactly the same as '''assignment_team.rb, L103''', so we move it to a module named Instance_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and AssignmentTeam model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Instance_method<br />
<br />
* module Instance_method<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = []<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each {|f| files << f }<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
===Self.import method===<br />
The self.import method of AssignmentParticipant model is exactly the same as '''course_participant.rb, L21''', so we move it to a module named Class_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and CourseParticipant model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Class_method<br />
<br />
def self.import(row, _row_header = nil, session, id)<br />
user = AssignmentParticipant.check_info_and_create(row, _row_header = nil, session)<br />
raise ImportError, "The assignment with id \"" + id.to_s + "\" was not found." if Assignment.find(id).nil?<br />
unless AssignmentParticipant.exists?(user_id: user.id, parent_id: id)<br />
new_part = AssignmentParticipant.create(user_id: user.id, parent_id: id)<br />
new_part.set_handle<br />
end<br />
end<br />
<br />
* module Class_method<br />
def check_info_and_create(row, _row_header = nil, session)<br />
raise ArgumentError, "No user id has been specified." if row.empty?<br />
user = User.find_by(name: row[0])<br />
if user.nil?<br />
raise ArgumentError, "The record containing #{row[0]} does not have enough items." if row.length < 4<br />
attributes = ImportFileHelper.define_attributes(row)<br />
user = ImportFileHelper.create_new_user(attributes, session)<br />
end<br />
end<br />
<br />
===Find_by method===<br />
Use '''find_by''' instead of dynamic method<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by(name:row[0])<br />
|-<br />
|}<br />
<br />
Use '''find_by''' instead of where.first<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109698CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T04:06:23Z<p>Cshao: /* Test */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at using TFD(Test First Development) to refactor the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc.<br />
<br />
We used the TDF(Test First Development) method to refactor the AssignmentParticipant model. With the RSpec tool, we wrote 38 test cases for 24 methods in '''assignment_participant_spec.rb''' first. After finishing these test cases, we executed them, and most of them failed. And then we refactored the methods, '''scores''', '''files''', '''self.import''', '''find_by''', '''where.first''', and executed the test cases again, finally they all passed.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
== Test ==<br />
Because the project is aimed at using TFD(Test First Development) to refactor the AssignmentParticipant model.<br />
We wrote 38 test cases for 24 methods in '''assignment_participant_spec.rb''' first, with the RSpec tool.<br />
describe '#dir_path' do<br />
it 'returns the directory path of current assignment' do<br />
expect(participant.dir_path).to eq "final_test"<br />
end<br />
end<br />
<br />
describe '#assign_quiz' do<br />
it 'creates a new QuizResponseMap record' do<br />
allow(QuizQuestionnaire).to receive(:find_by).with(instructor_id: 1).and_return(quiz_questionaire) # WHY CAN NOT DELETE THIS SENTENCE<br />
expect { participant.assign_quiz(participant, participant2, nil) }.to change { QuizResponseMap.count }.from(0).to(1)<br />
expect(participant.assign_quiz(participant, participant2, nil)).to be_an_instance_of(QuizResponseMap)<br />
end<br />
end<br />
<br />
describe '#reviewers' do<br />
it 'returns all the participants in this assignment who have reviewed the team where this participant belongs' do<br />
allow(ReviewResponseMap).to receive(:where).with(any_args).and_return([response_map]) # differences with .with(parameter)<br />
allow(AssignmentParticipant).to receive(:find).with(any_args).and_return(participant2)<br />
expect(participant.reviewers).to eq([participant2])<br />
end<br />
end<br />
<br />
describe '#review_score' do<br />
it 'returns the review score' do<br />
# diao yong de method tai duo le,er qie bu zhi dao sha yi si<br />
allow(review_questionnaire).to receive(:get_assessments_for).with(any_args).and_return([response])<br />
allow(review_questionnaire).to receive(:questions).and_return(question)<br />
allow(Answer).to receive(:compute_scores).with([response], question).and_return(avg: 100)<br />
allow(review_questionnaire).to receive(:max_possible_score).and_return(100)<br />
expect(participant.review_score).to eq(100)<br />
end<br />
end<br />
<br />
describe '#scores' do<br />
context 'when assignment is not varying rubric by round and not an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(false)<br />
allow(assignment).to receive(:is_microtask?).and_return(false)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
<br />
context 'when assignment is varying rubric by round but not an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(true)<br />
expect(participant).to receive(:merge_scores)<br />
allow(assignment).to receive(:is_microtask?).and_return(false)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
<br />
context 'when assignment is not varying rubric by round but an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(false)<br />
allow(assignment).to receive(:is_microtask?).and_return(true)<br />
expect(participant).to receive(:topic_total_scores)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
end<br />
<br />
# included method<br />
describe '#assignment_questionnaires' do<br />
context 'when the round of questionnaire is nil' do<br />
it 'record the result as review scores' do<br />
scores = {}<br />
question_hash = {review: question}<br />
score_map = {max: 100, min: 100, avg: 100}<br />
allow(AssignmentQuestionnaire).to receive(:find_by).with(any_args).and_return(assignment_questionnaire)<br />
allow(review_questionnaire).to receive(:get_assessments_for).with(any_args).and_return([response])<br />
allow(Answer).to receive(:compute_scores).with(any_args).and_return(score_map)<br />
participant.assignment_questionnaires(question_hash, scores)<br />
expect(scores[:review][:assessments]).to eq([response])<br />
expect(scores[:review][:scores]).to eq(score_map)<br />
end<br />
end<br />
<br />
context 'when the round of questionnaire is not nil' do<br />
it 'record the result as review#{n} scores' do<br />
scores = {}<br />
question_hash = {review1: question}<br />
score_map = {max: 100, min: 100, avg: 100}<br />
allow(AssignmentQuestionnaire).to receive(:find_by).and_return(assignment_questionnaire2)<br />
allow(review_questionnaire).to receive(:get_assessments_round_for).with(any_args).and_return([response])<br />
allow(Answer).to receive(:compute_scores).with(any_args).and_return(score_map)<br />
participant.assignment_questionnaires(question_hash, scores)<br />
expect(scores[:review1][:assessments]).to eq([response])<br />
expect(scores[:review1][:scores]).to eq(score_map)<br />
end<br />
end<br />
end<br />
<br />
describe '#merge_scores' do<br />
context 'when all of the review_n are nil' do<br />
it 'set max, min, avg of review score as 0' do<br />
scores = {}<br />
allow(assignment).to receive(:num_review_rounds).and_return(1)<br />
participant.merge_scores(scores)<br />
expect(scores[:review][:scores][:max]).to eq(0)<br />
expect(scores[:review][:scores][:min]).to eq(0)<br />
expect(scores[:review][:scores][:min]).to eq(0)<br />
end<br />
end<br />
<br />
context 'when the review_n is not nil' do<br />
it 'merge the score of review_n to the score of review' do<br />
score_map = {max: 100, min: 100, avg: 100}<br />
scores = {review1: {scores: score_map, assessments: [response]}}<br />
allow(assignment).to receive(:num_review_rounds).and_return(1)<br />
participant.merge_scores(scores)<br />
expect(scores[:review][:scores][:max]).to eq(100)<br />
expect(scores[:review][:scores][:min]).to eq(100)<br />
expect(scores[:review][:scores][:min]).to eq(100)<br />
end<br />
end<br />
end<br />
<br />
describe '#topic_total_scores' do<br />
it 'set total_score and max_pts_available of score when topic is not nil' do<br />
scores = {total_score: 100}<br />
allow(SignUpTopic).to receive(:find_by).with(any_args).and_return(topic)<br />
participant.topic_total_scores(scores)<br />
expect(scores[:total_score]).to eq(0)<br />
expect(scores[:max_pts_available]).to eq(0)<br />
end<br />
end<br />
<br />
describe '#caculate_scores' do<br />
context 'when the participant has the grade' do<br />
it 'his total scores equals his grade' do<br />
scores = {}<br />
expect(participant2.caculate_scores(scores)).to eq(100.0)<br />
end<br />
end<br />
context 'when the participant has the grade and the total score more than 100' do<br />
it 'return the score of a given participant with total score 100' do<br />
scores = {total_score: 110}<br />
expect(participant.caculate_scores(scores)).to eq(total_score: 100)<br />
end<br />
end<br />
context 'when the participant has the grade and the total score less than 100' do<br />
it 'return the score of a given participant with total score' do<br />
scores = {total_score: 90}<br />
expect(participant.caculate_scores(scores)).to eq(total_score: 90)<br />
end<br />
end<br />
end<br />
<br />
describe '#copy' do<br />
it 'copies assignment participants to a certain course' do<br />
expect(participant.copy(517)).to be_an_instance_of(CourseParticipant)<br />
end<br />
end<br />
<br />
describe '#feedback' do<br />
it 'returns corrsponding author feedback responses given by current participant' do<br />
expect(participant.feedback).to eq([response])<br />
end<br />
end<br />
<br />
describe '#reviews' do<br />
it 'returns corrsponding peer review responses given by current team' do<br />
expect(participant.reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#reviews_by_reviewer' do<br />
it 'returns corrsponding peer review responses given by certain reviewer' do<br />
allow(ReviewResponseMap).to receive(:get_reviewer_assessments_for).with(team, participant2).and_return([response])<br />
expect(participant.reviews_by_reviewer(participant2)).to eq([response])<br />
end<br />
end<br />
<br />
describe '#quizzes_taken' do<br />
it 'returns corrsponding quiz responses given by current participant' do<br />
expect(participant.quizzes_taken).to eq([response])<br />
end<br />
end<br />
<br />
describe '#metareviews' do<br />
it 'returns corrsponding metareview responses given by current participant' do<br />
expect(participant.metareviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#teammate_reviews' do<br />
it 'returns corrsponding teammate review responses given by current participant' do<br />
expect(participant.teammate_reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#bookmark_reviews' do<br />
it 'returns corrsponding bookmark review responses given by current participant' do<br />
expect(participant.bookmark_reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#files' do<br />
context 'when there is not subdirectory in current directory' do<br />
it 'returns all files in current directory' do<br />
allow(Dir).to receive(:[]).with("a/*").and_return(["a/k.rb"])<br />
allow(File).to receive(:directory?).with("a/k.rb").and_return(false)<br />
expect(participant.files("a")).to eq(["a/k.rb"])<br />
end<br />
end<br />
<br />
context 'when there is subdirectory in current directory' do<br />
it 'recursively returns all files in current directory' do<br />
allow(Dir).to receive(:[]).with("a/*").and_return(["a/b"])<br />
allow(File).to receive(:directory?).with("a/b").and_return(true)<br />
allow(Dir).to receive(:[]).with("a/b/*").and_return(["a/b/k.rb"])<br />
allow(File).to receive(:directory?).with("a/b/k.rb").and_return(false)<br />
expect(participant.files("a")).to eq(["a/b/k.rb", "a/b"])<br />
end<br />
end<br />
end<br />
<br />
describe ".import" do<br />
context 'when record is empty' do<br />
it 'raises an ArgumentError' do<br />
row = []<br />
allow(AssignmentParticipant).to receive(:check_info_and_create).with(any_args).and_raise("No user id has been specified.")<br />
expect(AssignmentParticipant).to receive(:check_info_and_create)<br />
expect { AssignmentParticipant.import(row, nil, nil, nil) }.to raise_error("No user id has been specified.")<br />
end<br />
end<br />
<br />
context 'when no user is found by offered username' do<br />
context 'when the record has less than 4 items' do<br />
it 'raises an ArgumentError' do<br />
row = ["user_name", "user_fullname", "name@email.com"]<br />
allow(AssignmentParticipant).<br />
to receive(:check_info_and_create).with(any_args).and_raise("The record containing #{row[0]} does not have enough items.")<br />
expect(AssignmentParticipant).to receive(:check_info_and_create)<br />
expect { AssignmentParticipant.import(row, nil, nil, nil) }.to raise_error("The record containing #{row[0]} does not have enough items.")<br />
end<br />
end<br />
<br />
context 'when the record has more than 4 items' do<br />
context 'when certain assignment cannot be found' do<br />
it 'creates a new user based on import information and raises an ImportError' do<br />
row = ["user_name", "user_fullname", "name@email.com", "user_role_name", "user_parent_name"]<br />
session = {user: participant}<br />
allow(User).to receive(:find_by).with(any_args).and_return(nil)<br />
allow(Assignment).to receive(:find).with(2).and_return(nil)<br />
expect { AssignmentParticipant.import(row, nil, session, 2) }.<br />
to raise_error("The assignment with id \"2\" was not found.").and change { User.count }.by(1)<br />
end<br />
end<br />
<br />
context 'when certain assignment can be found and assignment participant does not exists' do<br />
it 'creates a new user, new participant and raises an ImportError' do<br />
row = ["user_name", "user_fullname", "name@email.com", "user_role_name", "user_parent_name"]<br />
session = {user: participant}<br />
allow(User).to receive(:find_by_name).with(any_args).and_return(nil)<br />
allow(Assignment).to receive(:find).with(2).and_return(assignment)<br />
allow(AssignmentParticipant).to receive(:exists?).and_return(false)<br />
expect { AssignmentParticipant.import(row, nil, session, 2) }.to change { User.count }.by(1).and change { AssignmentParticipant.count }.by(1)<br />
end<br />
end<br />
end<br />
end<br />
end<br />
<br />
describe '.export' do<br />
it 'exports all participants in current assignment' do<br />
csv = []<br />
expect(AssignmentParticipant).to receive_message_chain(:where, :find_each).with(any_args).and_yield(participant)<br />
expect(AssignmentParticipant.export(csv, 1, any_args)).<br />
to eq([["student2064", "2064, student", "expertiza@mailinator.com", "Student", "instructor6", true, true, true, "handle"]])<br />
end<br />
end<br />
<br />
describe '#set_handle' do<br />
context 'when the user of current participant does not have handle' do<br />
it 'sets the user name as the handle of current participant' do<br />
allow(student).to receive_message_chain(:handle, :nil?).and_return(true)<br />
allow(student).to receive(:handle).and_return("")<br />
participant.set_handle<br />
expect(participant.handle).to eq("student2064")<br />
end<br />
end<br />
<br />
context 'when current assignment exists participants with same handle as the one of current user' do<br />
it 'sets the user name as the name of current participant' do<br />
allow(AssignmentParticipant).to receive(:exists?).with(any_args).and_return(true)<br />
participant.set_handle<br />
expect(participant.handle).to eq("student2064")<br />
end<br />
end<br />
<br />
context 'when current assignment does not have participants with same handle as the one of current user' do<br />
it 'sets the user name as the handle of current participant' do<br />
participant.set_handle<br />
expect(participant.handle).to eq("handle")<br />
end<br />
end<br />
end<br />
<br />
describe '#review_file_path' do<br />
it 'returns the file path for reviewer to upload files during peer review' do<br />
allow(ResponseMap).to receive(:find).with(any_args).and_return(response_map)<br />
allow(TeamsUser).to receive_message_chain(:find_by, :user_id).with(any_args).and_return(1)<br />
allow(Participant).to receive(:find_by).with(any_args).and_return(participant)<br />
file_path = Rails.root.to_s + "/pg_data/instructor6/csc517/test/final_test/0_review/1"<br />
expect(participant.review_file_path(1)).to eq(file_path)<br />
end<br />
end<br />
<br />
describe '#current_stage' do<br />
it 'returns stage of current assignment' do<br />
allow(assignment).to receive(:get_current_stage).with(1).and_return("Finished")<br />
expect(participant.current_stage).to eq("Finished")<br />
end<br />
end<br />
<br />
describe '#stage_deadline' do<br />
context 'when stage of current assignment is not Finished' do<br />
it 'returns current stage' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Unknow")<br />
expect(participant.stage_deadline).to eq("Unknow")<br />
end<br />
end<br />
<br />
context 'when stage of current assignment not Finished' do<br />
context 'current assignment is not a staggered deadline assignment' do<br />
it 'returns the due date of current assignment' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Finished")<br />
allow(assignment).to receive(:staggered_deadline?).and_return(false)<br />
allow(assignment).to receive_message_chain(:due_dates, :last, :due_at).and_return(1)<br />
expect(participant.stage_deadline).to eq("1")<br />
end<br />
end<br />
<br />
context 'current assignment is a staggered deadline assignment' do<br />
it 'returns the due date of current topic' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Finished")<br />
allow(assignment).to receive(:staggered_deadline?).and_return(true)<br />
allow(TopicDueDate).to receive_message_chain(:find_by, :last, :due_at).and_return(1)<br />
expect(participant.stage_deadline).to eq("1")<br />
end<br />
end<br />
end<br />
end<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===Files method===<br />
The files method of AssignmentParticipant model is exactly the same as '''assignment_team.rb, L103''', so we move it to a module named Instance_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and AssignmentTeam model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Instance_method<br />
<br />
* module Instance_method<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = []<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each {|f| files << f }<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
===Self.import method===<br />
The self.import method of AssignmentParticipant model is exactly the same as '''course_participant.rb, L21''', so we move it to a module named Class_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and CourseParticipant model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Class_method<br />
<br />
def self.import(row, _row_header = nil, session, id)<br />
user = AssignmentParticipant.check_info_and_create(row, _row_header = nil, session)<br />
raise ImportError, "The assignment with id \"" + id.to_s + "\" was not found." if Assignment.find(id).nil?<br />
unless AssignmentParticipant.exists?(user_id: user.id, parent_id: id)<br />
new_part = AssignmentParticipant.create(user_id: user.id, parent_id: id)<br />
new_part.set_handle<br />
end<br />
end<br />
<br />
* module Class_method<br />
def check_info_and_create(row, _row_header = nil, session)<br />
raise ArgumentError, "No user id has been specified." if row.empty?<br />
user = User.find_by(name: row[0])<br />
if user.nil?<br />
raise ArgumentError, "The record containing #{row[0]} does not have enough items." if row.length < 4<br />
attributes = ImportFileHelper.define_attributes(row)<br />
user = ImportFileHelper.create_new_user(attributes, session)<br />
end<br />
end<br />
<br />
===Find_by method===<br />
Use '''find_by''' instead of dynamic method<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by(name:row[0])<br />
|-<br />
|}<br />
<br />
Use '''find_by''' instead of where.first<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109697CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T04:06:01Z<p>Cshao: </p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at using TFD(Test First Development) to refactor the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc.<br />
<br />
We used the TDF(Test First Development) method to refactor the AssignmentParticipant model. With the RSpec tool, we wrote 38 test cases for 24 methods in '''assignment_participant_spec.rb''' first. After finishing these test cases, we executed them, and most of them failed. And then we refactored the methods, '''scores''', '''files''', '''self.import''', '''find_by''', '''where.first''', and executed the test cases again, finally they all passed.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
== Test ==<br />
Because the project is aimed at using TFD(Test First Development) to refactor the AssignmentParticipant model<br />
We wrote 38 test cases for 24 methods in '''assignment_participant_spec.rb''' first, with the RSpec tool.<br />
describe '#dir_path' do<br />
it 'returns the directory path of current assignment' do<br />
expect(participant.dir_path).to eq "final_test"<br />
end<br />
end<br />
<br />
describe '#assign_quiz' do<br />
it 'creates a new QuizResponseMap record' do<br />
allow(QuizQuestionnaire).to receive(:find_by).with(instructor_id: 1).and_return(quiz_questionaire) # WHY CAN NOT DELETE THIS SENTENCE<br />
expect { participant.assign_quiz(participant, participant2, nil) }.to change { QuizResponseMap.count }.from(0).to(1)<br />
expect(participant.assign_quiz(participant, participant2, nil)).to be_an_instance_of(QuizResponseMap)<br />
end<br />
end<br />
<br />
describe '#reviewers' do<br />
it 'returns all the participants in this assignment who have reviewed the team where this participant belongs' do<br />
allow(ReviewResponseMap).to receive(:where).with(any_args).and_return([response_map]) # differences with .with(parameter)<br />
allow(AssignmentParticipant).to receive(:find).with(any_args).and_return(participant2)<br />
expect(participant.reviewers).to eq([participant2])<br />
end<br />
end<br />
<br />
describe '#review_score' do<br />
it 'returns the review score' do<br />
# diao yong de method tai duo le,er qie bu zhi dao sha yi si<br />
allow(review_questionnaire).to receive(:get_assessments_for).with(any_args).and_return([response])<br />
allow(review_questionnaire).to receive(:questions).and_return(question)<br />
allow(Answer).to receive(:compute_scores).with([response], question).and_return(avg: 100)<br />
allow(review_questionnaire).to receive(:max_possible_score).and_return(100)<br />
expect(participant.review_score).to eq(100)<br />
end<br />
end<br />
<br />
describe '#scores' do<br />
context 'when assignment is not varying rubric by round and not an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(false)<br />
allow(assignment).to receive(:is_microtask?).and_return(false)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
<br />
context 'when assignment is varying rubric by round but not an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(true)<br />
expect(participant).to receive(:merge_scores)<br />
allow(assignment).to receive(:is_microtask?).and_return(false)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
<br />
context 'when assignment is not varying rubric by round but an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(false)<br />
allow(assignment).to receive(:is_microtask?).and_return(true)<br />
expect(participant).to receive(:topic_total_scores)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
end<br />
<br />
# included method<br />
describe '#assignment_questionnaires' do<br />
context 'when the round of questionnaire is nil' do<br />
it 'record the result as review scores' do<br />
scores = {}<br />
question_hash = {review: question}<br />
score_map = {max: 100, min: 100, avg: 100}<br />
allow(AssignmentQuestionnaire).to receive(:find_by).with(any_args).and_return(assignment_questionnaire)<br />
allow(review_questionnaire).to receive(:get_assessments_for).with(any_args).and_return([response])<br />
allow(Answer).to receive(:compute_scores).with(any_args).and_return(score_map)<br />
participant.assignment_questionnaires(question_hash, scores)<br />
expect(scores[:review][:assessments]).to eq([response])<br />
expect(scores[:review][:scores]).to eq(score_map)<br />
end<br />
end<br />
<br />
context 'when the round of questionnaire is not nil' do<br />
it 'record the result as review#{n} scores' do<br />
scores = {}<br />
question_hash = {review1: question}<br />
score_map = {max: 100, min: 100, avg: 100}<br />
allow(AssignmentQuestionnaire).to receive(:find_by).and_return(assignment_questionnaire2)<br />
allow(review_questionnaire).to receive(:get_assessments_round_for).with(any_args).and_return([response])<br />
allow(Answer).to receive(:compute_scores).with(any_args).and_return(score_map)<br />
participant.assignment_questionnaires(question_hash, scores)<br />
expect(scores[:review1][:assessments]).to eq([response])<br />
expect(scores[:review1][:scores]).to eq(score_map)<br />
end<br />
end<br />
end<br />
<br />
describe '#merge_scores' do<br />
context 'when all of the review_n are nil' do<br />
it 'set max, min, avg of review score as 0' do<br />
scores = {}<br />
allow(assignment).to receive(:num_review_rounds).and_return(1)<br />
participant.merge_scores(scores)<br />
expect(scores[:review][:scores][:max]).to eq(0)<br />
expect(scores[:review][:scores][:min]).to eq(0)<br />
expect(scores[:review][:scores][:min]).to eq(0)<br />
end<br />
end<br />
<br />
context 'when the review_n is not nil' do<br />
it 'merge the score of review_n to the score of review' do<br />
score_map = {max: 100, min: 100, avg: 100}<br />
scores = {review1: {scores: score_map, assessments: [response]}}<br />
allow(assignment).to receive(:num_review_rounds).and_return(1)<br />
participant.merge_scores(scores)<br />
expect(scores[:review][:scores][:max]).to eq(100)<br />
expect(scores[:review][:scores][:min]).to eq(100)<br />
expect(scores[:review][:scores][:min]).to eq(100)<br />
end<br />
end<br />
end<br />
<br />
describe '#topic_total_scores' do<br />
it 'set total_score and max_pts_available of score when topic is not nil' do<br />
scores = {total_score: 100}<br />
allow(SignUpTopic).to receive(:find_by).with(any_args).and_return(topic)<br />
participant.topic_total_scores(scores)<br />
expect(scores[:total_score]).to eq(0)<br />
expect(scores[:max_pts_available]).to eq(0)<br />
end<br />
end<br />
<br />
describe '#caculate_scores' do<br />
context 'when the participant has the grade' do<br />
it 'his total scores equals his grade' do<br />
scores = {}<br />
expect(participant2.caculate_scores(scores)).to eq(100.0)<br />
end<br />
end<br />
context 'when the participant has the grade and the total score more than 100' do<br />
it 'return the score of a given participant with total score 100' do<br />
scores = {total_score: 110}<br />
expect(participant.caculate_scores(scores)).to eq(total_score: 100)<br />
end<br />
end<br />
context 'when the participant has the grade and the total score less than 100' do<br />
it 'return the score of a given participant with total score' do<br />
scores = {total_score: 90}<br />
expect(participant.caculate_scores(scores)).to eq(total_score: 90)<br />
end<br />
end<br />
end<br />
<br />
describe '#copy' do<br />
it 'copies assignment participants to a certain course' do<br />
expect(participant.copy(517)).to be_an_instance_of(CourseParticipant)<br />
end<br />
end<br />
<br />
describe '#feedback' do<br />
it 'returns corrsponding author feedback responses given by current participant' do<br />
expect(participant.feedback).to eq([response])<br />
end<br />
end<br />
<br />
describe '#reviews' do<br />
it 'returns corrsponding peer review responses given by current team' do<br />
expect(participant.reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#reviews_by_reviewer' do<br />
it 'returns corrsponding peer review responses given by certain reviewer' do<br />
allow(ReviewResponseMap).to receive(:get_reviewer_assessments_for).with(team, participant2).and_return([response])<br />
expect(participant.reviews_by_reviewer(participant2)).to eq([response])<br />
end<br />
end<br />
<br />
describe '#quizzes_taken' do<br />
it 'returns corrsponding quiz responses given by current participant' do<br />
expect(participant.quizzes_taken).to eq([response])<br />
end<br />
end<br />
<br />
describe '#metareviews' do<br />
it 'returns corrsponding metareview responses given by current participant' do<br />
expect(participant.metareviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#teammate_reviews' do<br />
it 'returns corrsponding teammate review responses given by current participant' do<br />
expect(participant.teammate_reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#bookmark_reviews' do<br />
it 'returns corrsponding bookmark review responses given by current participant' do<br />
expect(participant.bookmark_reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#files' do<br />
context 'when there is not subdirectory in current directory' do<br />
it 'returns all files in current directory' do<br />
allow(Dir).to receive(:[]).with("a/*").and_return(["a/k.rb"])<br />
allow(File).to receive(:directory?).with("a/k.rb").and_return(false)<br />
expect(participant.files("a")).to eq(["a/k.rb"])<br />
end<br />
end<br />
<br />
context 'when there is subdirectory in current directory' do<br />
it 'recursively returns all files in current directory' do<br />
allow(Dir).to receive(:[]).with("a/*").and_return(["a/b"])<br />
allow(File).to receive(:directory?).with("a/b").and_return(true)<br />
allow(Dir).to receive(:[]).with("a/b/*").and_return(["a/b/k.rb"])<br />
allow(File).to receive(:directory?).with("a/b/k.rb").and_return(false)<br />
expect(participant.files("a")).to eq(["a/b/k.rb", "a/b"])<br />
end<br />
end<br />
end<br />
<br />
describe ".import" do<br />
context 'when record is empty' do<br />
it 'raises an ArgumentError' do<br />
row = []<br />
allow(AssignmentParticipant).to receive(:check_info_and_create).with(any_args).and_raise("No user id has been specified.")<br />
expect(AssignmentParticipant).to receive(:check_info_and_create)<br />
expect { AssignmentParticipant.import(row, nil, nil, nil) }.to raise_error("No user id has been specified.")<br />
end<br />
end<br />
<br />
context 'when no user is found by offered username' do<br />
context 'when the record has less than 4 items' do<br />
it 'raises an ArgumentError' do<br />
row = ["user_name", "user_fullname", "name@email.com"]<br />
allow(AssignmentParticipant).<br />
to receive(:check_info_and_create).with(any_args).and_raise("The record containing #{row[0]} does not have enough items.")<br />
expect(AssignmentParticipant).to receive(:check_info_and_create)<br />
expect { AssignmentParticipant.import(row, nil, nil, nil) }.to raise_error("The record containing #{row[0]} does not have enough items.")<br />
end<br />
end<br />
<br />
context 'when the record has more than 4 items' do<br />
context 'when certain assignment cannot be found' do<br />
it 'creates a new user based on import information and raises an ImportError' do<br />
row = ["user_name", "user_fullname", "name@email.com", "user_role_name", "user_parent_name"]<br />
session = {user: participant}<br />
allow(User).to receive(:find_by).with(any_args).and_return(nil)<br />
allow(Assignment).to receive(:find).with(2).and_return(nil)<br />
expect { AssignmentParticipant.import(row, nil, session, 2) }.<br />
to raise_error("The assignment with id \"2\" was not found.").and change { User.count }.by(1)<br />
end<br />
end<br />
<br />
context 'when certain assignment can be found and assignment participant does not exists' do<br />
it 'creates a new user, new participant and raises an ImportError' do<br />
row = ["user_name", "user_fullname", "name@email.com", "user_role_name", "user_parent_name"]<br />
session = {user: participant}<br />
allow(User).to receive(:find_by_name).with(any_args).and_return(nil)<br />
allow(Assignment).to receive(:find).with(2).and_return(assignment)<br />
allow(AssignmentParticipant).to receive(:exists?).and_return(false)<br />
expect { AssignmentParticipant.import(row, nil, session, 2) }.to change { User.count }.by(1).and change { AssignmentParticipant.count }.by(1)<br />
end<br />
end<br />
end<br />
end<br />
end<br />
<br />
describe '.export' do<br />
it 'exports all participants in current assignment' do<br />
csv = []<br />
expect(AssignmentParticipant).to receive_message_chain(:where, :find_each).with(any_args).and_yield(participant)<br />
expect(AssignmentParticipant.export(csv, 1, any_args)).<br />
to eq([["student2064", "2064, student", "expertiza@mailinator.com", "Student", "instructor6", true, true, true, "handle"]])<br />
end<br />
end<br />
<br />
describe '#set_handle' do<br />
context 'when the user of current participant does not have handle' do<br />
it 'sets the user name as the handle of current participant' do<br />
allow(student).to receive_message_chain(:handle, :nil?).and_return(true)<br />
allow(student).to receive(:handle).and_return("")<br />
participant.set_handle<br />
expect(participant.handle).to eq("student2064")<br />
end<br />
end<br />
<br />
context 'when current assignment exists participants with same handle as the one of current user' do<br />
it 'sets the user name as the name of current participant' do<br />
allow(AssignmentParticipant).to receive(:exists?).with(any_args).and_return(true)<br />
participant.set_handle<br />
expect(participant.handle).to eq("student2064")<br />
end<br />
end<br />
<br />
context 'when current assignment does not have participants with same handle as the one of current user' do<br />
it 'sets the user name as the handle of current participant' do<br />
participant.set_handle<br />
expect(participant.handle).to eq("handle")<br />
end<br />
end<br />
end<br />
<br />
describe '#review_file_path' do<br />
it 'returns the file path for reviewer to upload files during peer review' do<br />
allow(ResponseMap).to receive(:find).with(any_args).and_return(response_map)<br />
allow(TeamsUser).to receive_message_chain(:find_by, :user_id).with(any_args).and_return(1)<br />
allow(Participant).to receive(:find_by).with(any_args).and_return(participant)<br />
file_path = Rails.root.to_s + "/pg_data/instructor6/csc517/test/final_test/0_review/1"<br />
expect(participant.review_file_path(1)).to eq(file_path)<br />
end<br />
end<br />
<br />
describe '#current_stage' do<br />
it 'returns stage of current assignment' do<br />
allow(assignment).to receive(:get_current_stage).with(1).and_return("Finished")<br />
expect(participant.current_stage).to eq("Finished")<br />
end<br />
end<br />
<br />
describe '#stage_deadline' do<br />
context 'when stage of current assignment is not Finished' do<br />
it 'returns current stage' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Unknow")<br />
expect(participant.stage_deadline).to eq("Unknow")<br />
end<br />
end<br />
<br />
context 'when stage of current assignment not Finished' do<br />
context 'current assignment is not a staggered deadline assignment' do<br />
it 'returns the due date of current assignment' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Finished")<br />
allow(assignment).to receive(:staggered_deadline?).and_return(false)<br />
allow(assignment).to receive_message_chain(:due_dates, :last, :due_at).and_return(1)<br />
expect(participant.stage_deadline).to eq("1")<br />
end<br />
end<br />
<br />
context 'current assignment is a staggered deadline assignment' do<br />
it 'returns the due date of current topic' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Finished")<br />
allow(assignment).to receive(:staggered_deadline?).and_return(true)<br />
allow(TopicDueDate).to receive_message_chain(:find_by, :last, :due_at).and_return(1)<br />
expect(participant.stage_deadline).to eq("1")<br />
end<br />
end<br />
end<br />
end<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===Files method===<br />
The files method of AssignmentParticipant model is exactly the same as '''assignment_team.rb, L103''', so we move it to a module named Instance_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and AssignmentTeam model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Instance_method<br />
<br />
* module Instance_method<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = []<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each {|f| files << f }<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
===Self.import method===<br />
The self.import method of AssignmentParticipant model is exactly the same as '''course_participant.rb, L21''', so we move it to a module named Class_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and CourseParticipant model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Class_method<br />
<br />
def self.import(row, _row_header = nil, session, id)<br />
user = AssignmentParticipant.check_info_and_create(row, _row_header = nil, session)<br />
raise ImportError, "The assignment with id \"" + id.to_s + "\" was not found." if Assignment.find(id).nil?<br />
unless AssignmentParticipant.exists?(user_id: user.id, parent_id: id)<br />
new_part = AssignmentParticipant.create(user_id: user.id, parent_id: id)<br />
new_part.set_handle<br />
end<br />
end<br />
<br />
* module Class_method<br />
def check_info_and_create(row, _row_header = nil, session)<br />
raise ArgumentError, "No user id has been specified." if row.empty?<br />
user = User.find_by(name: row[0])<br />
if user.nil?<br />
raise ArgumentError, "The record containing #{row[0]} does not have enough items." if row.length < 4<br />
attributes = ImportFileHelper.define_attributes(row)<br />
user = ImportFileHelper.create_new_user(attributes, session)<br />
end<br />
end<br />
<br />
===Find_by method===<br />
Use '''find_by''' instead of dynamic method<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by(name:row[0])<br />
|-<br />
|}<br />
<br />
Use '''find_by''' instead of where.first<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109694CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T04:03:37Z<p>Cshao: /* Project Description */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at using TFD(Test First Development) to refactor the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc.<br />
<br />
We used the TDF(Test First Development) method to refactor the AssignmentParticipant model. With the RSpec tool, we wrote 38 test cases for 24 methods in AssignmentParticipant model first. After finishing these test cases, we executed them, and most of them failed. And then we refactored the methods, '''scores''', '''files''', '''self.import''', '''find_by''', '''where.first''', and executed the test cases again, finally they all passed.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
== Test ==<br />
describe '#dir_path' do<br />
it 'returns the directory path of current assignment' do<br />
expect(participant.dir_path).to eq "final_test"<br />
end<br />
end<br />
<br />
describe '#assign_quiz' do<br />
it 'creates a new QuizResponseMap record' do<br />
allow(QuizQuestionnaire).to receive(:find_by).with(instructor_id: 1).and_return(quiz_questionaire) # WHY CAN NOT DELETE THIS SENTENCE<br />
expect { participant.assign_quiz(participant, participant2, nil) }.to change { QuizResponseMap.count }.from(0).to(1)<br />
expect(participant.assign_quiz(participant, participant2, nil)).to be_an_instance_of(QuizResponseMap)<br />
end<br />
end<br />
<br />
describe '#reviewers' do<br />
it 'returns all the participants in this assignment who have reviewed the team where this participant belongs' do<br />
allow(ReviewResponseMap).to receive(:where).with(any_args).and_return([response_map]) # differences with .with(parameter)<br />
allow(AssignmentParticipant).to receive(:find).with(any_args).and_return(participant2)<br />
expect(participant.reviewers).to eq([participant2])<br />
end<br />
end<br />
<br />
describe '#review_score' do<br />
it 'returns the review score' do<br />
# diao yong de method tai duo le,er qie bu zhi dao sha yi si<br />
allow(review_questionnaire).to receive(:get_assessments_for).with(any_args).and_return([response])<br />
allow(review_questionnaire).to receive(:questions).and_return(question)<br />
allow(Answer).to receive(:compute_scores).with([response], question).and_return(avg: 100)<br />
allow(review_questionnaire).to receive(:max_possible_score).and_return(100)<br />
expect(participant.review_score).to eq(100)<br />
end<br />
end<br />
<br />
describe '#scores' do<br />
context 'when assignment is not varying rubric by round and not an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(false)<br />
allow(assignment).to receive(:is_microtask?).and_return(false)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
<br />
context 'when assignment is varying rubric by round but not an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(true)<br />
expect(participant).to receive(:merge_scores)<br />
allow(assignment).to receive(:is_microtask?).and_return(false)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
<br />
context 'when assignment is not varying rubric by round but an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(false)<br />
allow(assignment).to receive(:is_microtask?).and_return(true)<br />
expect(participant).to receive(:topic_total_scores)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
end<br />
<br />
# included method<br />
describe '#assignment_questionnaires' do<br />
context 'when the round of questionnaire is nil' do<br />
it 'record the result as review scores' do<br />
scores = {}<br />
question_hash = {review: question}<br />
score_map = {max: 100, min: 100, avg: 100}<br />
allow(AssignmentQuestionnaire).to receive(:find_by).with(any_args).and_return(assignment_questionnaire)<br />
allow(review_questionnaire).to receive(:get_assessments_for).with(any_args).and_return([response])<br />
allow(Answer).to receive(:compute_scores).with(any_args).and_return(score_map)<br />
participant.assignment_questionnaires(question_hash, scores)<br />
expect(scores[:review][:assessments]).to eq([response])<br />
expect(scores[:review][:scores]).to eq(score_map)<br />
end<br />
end<br />
<br />
context 'when the round of questionnaire is not nil' do<br />
it 'record the result as review#{n} scores' do<br />
scores = {}<br />
question_hash = {review1: question}<br />
score_map = {max: 100, min: 100, avg: 100}<br />
allow(AssignmentQuestionnaire).to receive(:find_by).and_return(assignment_questionnaire2)<br />
allow(review_questionnaire).to receive(:get_assessments_round_for).with(any_args).and_return([response])<br />
allow(Answer).to receive(:compute_scores).with(any_args).and_return(score_map)<br />
participant.assignment_questionnaires(question_hash, scores)<br />
expect(scores[:review1][:assessments]).to eq([response])<br />
expect(scores[:review1][:scores]).to eq(score_map)<br />
end<br />
end<br />
end<br />
<br />
describe '#merge_scores' do<br />
context 'when all of the review_n are nil' do<br />
it 'set max, min, avg of review score as 0' do<br />
scores = {}<br />
allow(assignment).to receive(:num_review_rounds).and_return(1)<br />
participant.merge_scores(scores)<br />
expect(scores[:review][:scores][:max]).to eq(0)<br />
expect(scores[:review][:scores][:min]).to eq(0)<br />
expect(scores[:review][:scores][:min]).to eq(0)<br />
end<br />
end<br />
<br />
context 'when the review_n is not nil' do<br />
it 'merge the score of review_n to the score of review' do<br />
score_map = {max: 100, min: 100, avg: 100}<br />
scores = {review1: {scores: score_map, assessments: [response]}}<br />
allow(assignment).to receive(:num_review_rounds).and_return(1)<br />
participant.merge_scores(scores)<br />
expect(scores[:review][:scores][:max]).to eq(100)<br />
expect(scores[:review][:scores][:min]).to eq(100)<br />
expect(scores[:review][:scores][:min]).to eq(100)<br />
end<br />
end<br />
end<br />
<br />
describe '#topic_total_scores' do<br />
it 'set total_score and max_pts_available of score when topic is not nil' do<br />
scores = {total_score: 100}<br />
allow(SignUpTopic).to receive(:find_by).with(any_args).and_return(topic)<br />
participant.topic_total_scores(scores)<br />
expect(scores[:total_score]).to eq(0)<br />
expect(scores[:max_pts_available]).to eq(0)<br />
end<br />
end<br />
<br />
describe '#caculate_scores' do<br />
context 'when the participant has the grade' do<br />
it 'his total scores equals his grade' do<br />
scores = {}<br />
expect(participant2.caculate_scores(scores)).to eq(100.0)<br />
end<br />
end<br />
context 'when the participant has the grade and the total score more than 100' do<br />
it 'return the score of a given participant with total score 100' do<br />
scores = {total_score: 110}<br />
expect(participant.caculate_scores(scores)).to eq(total_score: 100)<br />
end<br />
end<br />
context 'when the participant has the grade and the total score less than 100' do<br />
it 'return the score of a given participant with total score' do<br />
scores = {total_score: 90}<br />
expect(participant.caculate_scores(scores)).to eq(total_score: 90)<br />
end<br />
end<br />
end<br />
<br />
describe '#copy' do<br />
it 'copies assignment participants to a certain course' do<br />
expect(participant.copy(517)).to be_an_instance_of(CourseParticipant)<br />
end<br />
end<br />
<br />
describe '#feedback' do<br />
it 'returns corrsponding author feedback responses given by current participant' do<br />
expect(participant.feedback).to eq([response])<br />
end<br />
end<br />
<br />
describe '#reviews' do<br />
it 'returns corrsponding peer review responses given by current team' do<br />
expect(participant.reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#reviews_by_reviewer' do<br />
it 'returns corrsponding peer review responses given by certain reviewer' do<br />
allow(ReviewResponseMap).to receive(:get_reviewer_assessments_for).with(team, participant2).and_return([response])<br />
expect(participant.reviews_by_reviewer(participant2)).to eq([response])<br />
end<br />
end<br />
<br />
describe '#quizzes_taken' do<br />
it 'returns corrsponding quiz responses given by current participant' do<br />
expect(participant.quizzes_taken).to eq([response])<br />
end<br />
end<br />
<br />
describe '#metareviews' do<br />
it 'returns corrsponding metareview responses given by current participant' do<br />
expect(participant.metareviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#teammate_reviews' do<br />
it 'returns corrsponding teammate review responses given by current participant' do<br />
expect(participant.teammate_reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#bookmark_reviews' do<br />
it 'returns corrsponding bookmark review responses given by current participant' do<br />
expect(participant.bookmark_reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#files' do<br />
context 'when there is not subdirectory in current directory' do<br />
it 'returns all files in current directory' do<br />
allow(Dir).to receive(:[]).with("a/*").and_return(["a/k.rb"])<br />
allow(File).to receive(:directory?).with("a/k.rb").and_return(false)<br />
expect(participant.files("a")).to eq(["a/k.rb"])<br />
end<br />
end<br />
<br />
context 'when there is subdirectory in current directory' do<br />
it 'recursively returns all files in current directory' do<br />
allow(Dir).to receive(:[]).with("a/*").and_return(["a/b"])<br />
allow(File).to receive(:directory?).with("a/b").and_return(true)<br />
allow(Dir).to receive(:[]).with("a/b/*").and_return(["a/b/k.rb"])<br />
allow(File).to receive(:directory?).with("a/b/k.rb").and_return(false)<br />
expect(participant.files("a")).to eq(["a/b/k.rb", "a/b"])<br />
end<br />
end<br />
end<br />
<br />
describe ".import" do<br />
context 'when record is empty' do<br />
it 'raises an ArgumentError' do<br />
row = []<br />
allow(AssignmentParticipant).to receive(:check_info_and_create).with(any_args).and_raise("No user id has been specified.")<br />
expect(AssignmentParticipant).to receive(:check_info_and_create)<br />
expect { AssignmentParticipant.import(row, nil, nil, nil) }.to raise_error("No user id has been specified.")<br />
end<br />
end<br />
<br />
context 'when no user is found by offered username' do<br />
context 'when the record has less than 4 items' do<br />
it 'raises an ArgumentError' do<br />
row = ["user_name", "user_fullname", "name@email.com"]<br />
allow(AssignmentParticipant).<br />
to receive(:check_info_and_create).with(any_args).and_raise("The record containing #{row[0]} does not have enough items.")<br />
expect(AssignmentParticipant).to receive(:check_info_and_create)<br />
expect { AssignmentParticipant.import(row, nil, nil, nil) }.to raise_error("The record containing #{row[0]} does not have enough items.")<br />
end<br />
end<br />
<br />
context 'when the record has more than 4 items' do<br />
context 'when certain assignment cannot be found' do<br />
it 'creates a new user based on import information and raises an ImportError' do<br />
row = ["user_name", "user_fullname", "name@email.com", "user_role_name", "user_parent_name"]<br />
session = {user: participant}<br />
allow(User).to receive(:find_by).with(any_args).and_return(nil)<br />
allow(Assignment).to receive(:find).with(2).and_return(nil)<br />
expect { AssignmentParticipant.import(row, nil, session, 2) }.<br />
to raise_error("The assignment with id \"2\" was not found.").and change { User.count }.by(1)<br />
end<br />
end<br />
<br />
context 'when certain assignment can be found and assignment participant does not exists' do<br />
it 'creates a new user, new participant and raises an ImportError' do<br />
row = ["user_name", "user_fullname", "name@email.com", "user_role_name", "user_parent_name"]<br />
session = {user: participant}<br />
allow(User).to receive(:find_by_name).with(any_args).and_return(nil)<br />
allow(Assignment).to receive(:find).with(2).and_return(assignment)<br />
allow(AssignmentParticipant).to receive(:exists?).and_return(false)<br />
expect { AssignmentParticipant.import(row, nil, session, 2) }.to change { User.count }.by(1).and change { AssignmentParticipant.count }.by(1)<br />
end<br />
end<br />
end<br />
end<br />
end<br />
<br />
describe '.export' do<br />
it 'exports all participants in current assignment' do<br />
csv = []<br />
expect(AssignmentParticipant).to receive_message_chain(:where, :find_each).with(any_args).and_yield(participant)<br />
expect(AssignmentParticipant.export(csv, 1, any_args)).<br />
to eq([["student2064", "2064, student", "expertiza@mailinator.com", "Student", "instructor6", true, true, true, "handle"]])<br />
end<br />
end<br />
<br />
describe '#set_handle' do<br />
context 'when the user of current participant does not have handle' do<br />
it 'sets the user name as the handle of current participant' do<br />
allow(student).to receive_message_chain(:handle, :nil?).and_return(true)<br />
allow(student).to receive(:handle).and_return("")<br />
participant.set_handle<br />
expect(participant.handle).to eq("student2064")<br />
end<br />
end<br />
<br />
context 'when current assignment exists participants with same handle as the one of current user' do<br />
it 'sets the user name as the name of current participant' do<br />
allow(AssignmentParticipant).to receive(:exists?).with(any_args).and_return(true)<br />
participant.set_handle<br />
expect(participant.handle).to eq("student2064")<br />
end<br />
end<br />
<br />
context 'when current assignment does not have participants with same handle as the one of current user' do<br />
it 'sets the user name as the handle of current participant' do<br />
participant.set_handle<br />
expect(participant.handle).to eq("handle")<br />
end<br />
end<br />
end<br />
<br />
describe '#review_file_path' do<br />
it 'returns the file path for reviewer to upload files during peer review' do<br />
allow(ResponseMap).to receive(:find).with(any_args).and_return(response_map)<br />
allow(TeamsUser).to receive_message_chain(:find_by, :user_id).with(any_args).and_return(1)<br />
allow(Participant).to receive(:find_by).with(any_args).and_return(participant)<br />
file_path = Rails.root.to_s + "/pg_data/instructor6/csc517/test/final_test/0_review/1"<br />
expect(participant.review_file_path(1)).to eq(file_path)<br />
end<br />
end<br />
<br />
describe '#current_stage' do<br />
it 'returns stage of current assignment' do<br />
allow(assignment).to receive(:get_current_stage).with(1).and_return("Finished")<br />
expect(participant.current_stage).to eq("Finished")<br />
end<br />
end<br />
<br />
describe '#stage_deadline' do<br />
context 'when stage of current assignment is not Finished' do<br />
it 'returns current stage' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Unknow")<br />
expect(participant.stage_deadline).to eq("Unknow")<br />
end<br />
end<br />
<br />
context 'when stage of current assignment not Finished' do<br />
context 'current assignment is not a staggered deadline assignment' do<br />
it 'returns the due date of current assignment' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Finished")<br />
allow(assignment).to receive(:staggered_deadline?).and_return(false)<br />
allow(assignment).to receive_message_chain(:due_dates, :last, :due_at).and_return(1)<br />
expect(participant.stage_deadline).to eq("1")<br />
end<br />
end<br />
<br />
context 'current assignment is a staggered deadline assignment' do<br />
it 'returns the due date of current topic' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Finished")<br />
allow(assignment).to receive(:staggered_deadline?).and_return(true)<br />
allow(TopicDueDate).to receive_message_chain(:find_by, :last, :due_at).and_return(1)<br />
expect(participant.stage_deadline).to eq("1")<br />
end<br />
end<br />
end<br />
end<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===Files method===<br />
The files method of AssignmentParticipant model is exactly the same as '''assignment_team.rb, L103''', so we move it to a module named Instance_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and AssignmentTeam model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Instance_method<br />
<br />
* module Instance_method<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = []<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each {|f| files << f }<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
===Self.import method===<br />
The self.import method of AssignmentParticipant model is exactly the same as '''course_participant.rb, L21''', so we move it to a module named Class_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and CourseParticipant model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Class_method<br />
<br />
def self.import(row, _row_header = nil, session, id)<br />
user = AssignmentParticipant.check_info_and_create(row, _row_header = nil, session)<br />
raise ImportError, "The assignment with id \"" + id.to_s + "\" was not found." if Assignment.find(id).nil?<br />
unless AssignmentParticipant.exists?(user_id: user.id, parent_id: id)<br />
new_part = AssignmentParticipant.create(user_id: user.id, parent_id: id)<br />
new_part.set_handle<br />
end<br />
end<br />
<br />
* module Class_method<br />
def check_info_and_create(row, _row_header = nil, session)<br />
raise ArgumentError, "No user id has been specified." if row.empty?<br />
user = User.find_by(name: row[0])<br />
if user.nil?<br />
raise ArgumentError, "The record containing #{row[0]} does not have enough items." if row.length < 4<br />
attributes = ImportFileHelper.define_attributes(row)<br />
user = ImportFileHelper.create_new_user(attributes, session)<br />
end<br />
end<br />
<br />
===Find_by method===<br />
Use '''find_by''' instead of dynamic method<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by(name:row[0])<br />
|-<br />
|}<br />
<br />
Use '''find_by''' instead of where.first<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109692CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T04:02:48Z<p>Cshao: /* Test Cases */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at using TFD(Test First Development) to refactor the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc.<br />
<br />
We used the TDF(Test First Development) method to refactor the AssignmentParticipant model. With the RSpec tool, we wrote 38 test cases for 24 methods in AssignmentParticipant model first. After finishing these test cases, we executed them, and most of them failed. And then we refactored the methods, '''scores''', '''files''', '''self.import''', '''find_by''', '''where.first''', and executed the test cases again, finally they all passed.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
<br />
describe '#dir_path' do<br />
it 'returns the directory path of current assignment' do<br />
expect(participant.dir_path).to eq "final_test"<br />
end<br />
end<br />
<br />
describe '#assign_quiz' do<br />
it 'creates a new QuizResponseMap record' do<br />
allow(QuizQuestionnaire).to receive(:find_by).with(instructor_id: 1).and_return(quiz_questionaire) # WHY CAN NOT DELETE THIS SENTENCE<br />
expect { participant.assign_quiz(participant, participant2, nil) }.to change { QuizResponseMap.count }.from(0).to(1)<br />
expect(participant.assign_quiz(participant, participant2, nil)).to be_an_instance_of(QuizResponseMap)<br />
end<br />
end<br />
<br />
describe '#reviewers' do<br />
it 'returns all the participants in this assignment who have reviewed the team where this participant belongs' do<br />
allow(ReviewResponseMap).to receive(:where).with(any_args).and_return([response_map]) # differences with .with(parameter)<br />
allow(AssignmentParticipant).to receive(:find).with(any_args).and_return(participant2)<br />
expect(participant.reviewers).to eq([participant2])<br />
end<br />
end<br />
<br />
describe '#review_score' do<br />
it 'returns the review score' do<br />
# diao yong de method tai duo le,er qie bu zhi dao sha yi si<br />
allow(review_questionnaire).to receive(:get_assessments_for).with(any_args).and_return([response])<br />
allow(review_questionnaire).to receive(:questions).and_return(question)<br />
allow(Answer).to receive(:compute_scores).with([response], question).and_return(avg: 100)<br />
allow(review_questionnaire).to receive(:max_possible_score).and_return(100)<br />
expect(participant.review_score).to eq(100)<br />
end<br />
end<br />
<br />
describe '#scores' do<br />
context 'when assignment is not varying rubric by round and not an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(false)<br />
allow(assignment).to receive(:is_microtask?).and_return(false)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
<br />
context 'when assignment is varying rubric by round but not an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(true)<br />
expect(participant).to receive(:merge_scores)<br />
allow(assignment).to receive(:is_microtask?).and_return(false)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
<br />
context 'when assignment is not varying rubric by round but an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(false)<br />
allow(assignment).to receive(:is_microtask?).and_return(true)<br />
expect(participant).to receive(:topic_total_scores)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
end<br />
<br />
# included method<br />
describe '#assignment_questionnaires' do<br />
context 'when the round of questionnaire is nil' do<br />
it 'record the result as review scores' do<br />
scores = {}<br />
question_hash = {review: question}<br />
score_map = {max: 100, min: 100, avg: 100}<br />
allow(AssignmentQuestionnaire).to receive(:find_by).with(any_args).and_return(assignment_questionnaire)<br />
allow(review_questionnaire).to receive(:get_assessments_for).with(any_args).and_return([response])<br />
allow(Answer).to receive(:compute_scores).with(any_args).and_return(score_map)<br />
participant.assignment_questionnaires(question_hash, scores)<br />
expect(scores[:review][:assessments]).to eq([response])<br />
expect(scores[:review][:scores]).to eq(score_map)<br />
end<br />
end<br />
<br />
context 'when the round of questionnaire is not nil' do<br />
it 'record the result as review#{n} scores' do<br />
scores = {}<br />
question_hash = {review1: question}<br />
score_map = {max: 100, min: 100, avg: 100}<br />
allow(AssignmentQuestionnaire).to receive(:find_by).and_return(assignment_questionnaire2)<br />
allow(review_questionnaire).to receive(:get_assessments_round_for).with(any_args).and_return([response])<br />
allow(Answer).to receive(:compute_scores).with(any_args).and_return(score_map)<br />
participant.assignment_questionnaires(question_hash, scores)<br />
expect(scores[:review1][:assessments]).to eq([response])<br />
expect(scores[:review1][:scores]).to eq(score_map)<br />
end<br />
end<br />
end<br />
<br />
describe '#merge_scores' do<br />
context 'when all of the review_n are nil' do<br />
it 'set max, min, avg of review score as 0' do<br />
scores = {}<br />
allow(assignment).to receive(:num_review_rounds).and_return(1)<br />
participant.merge_scores(scores)<br />
expect(scores[:review][:scores][:max]).to eq(0)<br />
expect(scores[:review][:scores][:min]).to eq(0)<br />
expect(scores[:review][:scores][:min]).to eq(0)<br />
end<br />
end<br />
<br />
context 'when the review_n is not nil' do<br />
it 'merge the score of review_n to the score of review' do<br />
score_map = {max: 100, min: 100, avg: 100}<br />
scores = {review1: {scores: score_map, assessments: [response]}}<br />
allow(assignment).to receive(:num_review_rounds).and_return(1)<br />
participant.merge_scores(scores)<br />
expect(scores[:review][:scores][:max]).to eq(100)<br />
expect(scores[:review][:scores][:min]).to eq(100)<br />
expect(scores[:review][:scores][:min]).to eq(100)<br />
end<br />
end<br />
end<br />
<br />
describe '#topic_total_scores' do<br />
it 'set total_score and max_pts_available of score when topic is not nil' do<br />
scores = {total_score: 100}<br />
allow(SignUpTopic).to receive(:find_by).with(any_args).and_return(topic)<br />
participant.topic_total_scores(scores)<br />
expect(scores[:total_score]).to eq(0)<br />
expect(scores[:max_pts_available]).to eq(0)<br />
end<br />
end<br />
<br />
describe '#caculate_scores' do<br />
context 'when the participant has the grade' do<br />
it 'his total scores equals his grade' do<br />
scores = {}<br />
expect(participant2.caculate_scores(scores)).to eq(100.0)<br />
end<br />
end<br />
context 'when the participant has the grade and the total score more than 100' do<br />
it 'return the score of a given participant with total score 100' do<br />
scores = {total_score: 110}<br />
expect(participant.caculate_scores(scores)).to eq(total_score: 100)<br />
end<br />
end<br />
context 'when the participant has the grade and the total score less than 100' do<br />
it 'return the score of a given participant with total score' do<br />
scores = {total_score: 90}<br />
expect(participant.caculate_scores(scores)).to eq(total_score: 90)<br />
end<br />
end<br />
end<br />
<br />
describe '#copy' do<br />
it 'copies assignment participants to a certain course' do<br />
expect(participant.copy(517)).to be_an_instance_of(CourseParticipant)<br />
end<br />
end<br />
<br />
describe '#feedback' do<br />
it 'returns corrsponding author feedback responses given by current participant' do<br />
expect(participant.feedback).to eq([response])<br />
end<br />
end<br />
<br />
describe '#reviews' do<br />
it 'returns corrsponding peer review responses given by current team' do<br />
expect(participant.reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#reviews_by_reviewer' do<br />
it 'returns corrsponding peer review responses given by certain reviewer' do<br />
allow(ReviewResponseMap).to receive(:get_reviewer_assessments_for).with(team, participant2).and_return([response])<br />
expect(participant.reviews_by_reviewer(participant2)).to eq([response])<br />
end<br />
end<br />
<br />
describe '#quizzes_taken' do<br />
it 'returns corrsponding quiz responses given by current participant' do<br />
expect(participant.quizzes_taken).to eq([response])<br />
end<br />
end<br />
<br />
describe '#metareviews' do<br />
it 'returns corrsponding metareview responses given by current participant' do<br />
expect(participant.metareviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#teammate_reviews' do<br />
it 'returns corrsponding teammate review responses given by current participant' do<br />
expect(participant.teammate_reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#bookmark_reviews' do<br />
it 'returns corrsponding bookmark review responses given by current participant' do<br />
expect(participant.bookmark_reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#files' do<br />
context 'when there is not subdirectory in current directory' do<br />
it 'returns all files in current directory' do<br />
allow(Dir).to receive(:[]).with("a/*").and_return(["a/k.rb"])<br />
allow(File).to receive(:directory?).with("a/k.rb").and_return(false)<br />
expect(participant.files("a")).to eq(["a/k.rb"])<br />
end<br />
end<br />
<br />
context 'when there is subdirectory in current directory' do<br />
it 'recursively returns all files in current directory' do<br />
allow(Dir).to receive(:[]).with("a/*").and_return(["a/b"])<br />
allow(File).to receive(:directory?).with("a/b").and_return(true)<br />
allow(Dir).to receive(:[]).with("a/b/*").and_return(["a/b/k.rb"])<br />
allow(File).to receive(:directory?).with("a/b/k.rb").and_return(false)<br />
expect(participant.files("a")).to eq(["a/b/k.rb", "a/b"])<br />
end<br />
end<br />
end<br />
<br />
describe ".import" do<br />
context 'when record is empty' do<br />
it 'raises an ArgumentError' do<br />
row = []<br />
allow(AssignmentParticipant).to receive(:check_info_and_create).with(any_args).and_raise("No user id has been specified.")<br />
expect(AssignmentParticipant).to receive(:check_info_and_create)<br />
expect { AssignmentParticipant.import(row, nil, nil, nil) }.to raise_error("No user id has been specified.")<br />
end<br />
end<br />
<br />
context 'when no user is found by offered username' do<br />
context 'when the record has less than 4 items' do<br />
it 'raises an ArgumentError' do<br />
row = ["user_name", "user_fullname", "name@email.com"]<br />
allow(AssignmentParticipant).<br />
to receive(:check_info_and_create).with(any_args).and_raise("The record containing #{row[0]} does not have enough items.")<br />
expect(AssignmentParticipant).to receive(:check_info_and_create)<br />
expect { AssignmentParticipant.import(row, nil, nil, nil) }.to raise_error("The record containing #{row[0]} does not have enough items.")<br />
end<br />
end<br />
<br />
context 'when the record has more than 4 items' do<br />
context 'when certain assignment cannot be found' do<br />
it 'creates a new user based on import information and raises an ImportError' do<br />
row = ["user_name", "user_fullname", "name@email.com", "user_role_name", "user_parent_name"]<br />
session = {user: participant}<br />
allow(User).to receive(:find_by).with(any_args).and_return(nil)<br />
allow(Assignment).to receive(:find).with(2).and_return(nil)<br />
expect { AssignmentParticipant.import(row, nil, session, 2) }.<br />
to raise_error("The assignment with id \"2\" was not found.").and change { User.count }.by(1)<br />
end<br />
end<br />
<br />
context 'when certain assignment can be found and assignment participant does not exists' do<br />
it 'creates a new user, new participant and raises an ImportError' do<br />
row = ["user_name", "user_fullname", "name@email.com", "user_role_name", "user_parent_name"]<br />
session = {user: participant}<br />
allow(User).to receive(:find_by_name).with(any_args).and_return(nil)<br />
allow(Assignment).to receive(:find).with(2).and_return(assignment)<br />
allow(AssignmentParticipant).to receive(:exists?).and_return(false)<br />
expect { AssignmentParticipant.import(row, nil, session, 2) }.to change { User.count }.by(1).and change { AssignmentParticipant.count }.by(1)<br />
end<br />
end<br />
end<br />
end<br />
end<br />
<br />
describe '.export' do<br />
it 'exports all participants in current assignment' do<br />
csv = []<br />
expect(AssignmentParticipant).to receive_message_chain(:where, :find_each).with(any_args).and_yield(participant)<br />
expect(AssignmentParticipant.export(csv, 1, any_args)).<br />
to eq([["student2064", "2064, student", "expertiza@mailinator.com", "Student", "instructor6", true, true, true, "handle"]])<br />
end<br />
end<br />
<br />
describe '#set_handle' do<br />
context 'when the user of current participant does not have handle' do<br />
it 'sets the user name as the handle of current participant' do<br />
allow(student).to receive_message_chain(:handle, :nil?).and_return(true)<br />
allow(student).to receive(:handle).and_return("")<br />
participant.set_handle<br />
expect(participant.handle).to eq("student2064")<br />
end<br />
end<br />
<br />
context 'when current assignment exists participants with same handle as the one of current user' do<br />
it 'sets the user name as the name of current participant' do<br />
allow(AssignmentParticipant).to receive(:exists?).with(any_args).and_return(true)<br />
participant.set_handle<br />
expect(participant.handle).to eq("student2064")<br />
end<br />
end<br />
<br />
context 'when current assignment does not have participants with same handle as the one of current user' do<br />
it 'sets the user name as the handle of current participant' do<br />
participant.set_handle<br />
expect(participant.handle).to eq("handle")<br />
end<br />
end<br />
end<br />
<br />
describe '#review_file_path' do<br />
it 'returns the file path for reviewer to upload files during peer review' do<br />
allow(ResponseMap).to receive(:find).with(any_args).and_return(response_map)<br />
allow(TeamsUser).to receive_message_chain(:find_by, :user_id).with(any_args).and_return(1)<br />
allow(Participant).to receive(:find_by).with(any_args).and_return(participant)<br />
file_path = Rails.root.to_s + "/pg_data/instructor6/csc517/test/final_test/0_review/1"<br />
expect(participant.review_file_path(1)).to eq(file_path)<br />
end<br />
end<br />
<br />
describe '#current_stage' do<br />
it 'returns stage of current assignment' do<br />
allow(assignment).to receive(:get_current_stage).with(1).and_return("Finished")<br />
expect(participant.current_stage).to eq("Finished")<br />
end<br />
end<br />
<br />
describe '#stage_deadline' do<br />
context 'when stage of current assignment is not Finished' do<br />
it 'returns current stage' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Unknow")<br />
expect(participant.stage_deadline).to eq("Unknow")<br />
end<br />
end<br />
<br />
context 'when stage of current assignment not Finished' do<br />
context 'current assignment is not a staggered deadline assignment' do<br />
it 'returns the due date of current assignment' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Finished")<br />
allow(assignment).to receive(:staggered_deadline?).and_return(false)<br />
allow(assignment).to receive_message_chain(:due_dates, :last, :due_at).and_return(1)<br />
expect(participant.stage_deadline).to eq("1")<br />
end<br />
end<br />
<br />
context 'current assignment is a staggered deadline assignment' do<br />
it 'returns the due date of current topic' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Finished")<br />
allow(assignment).to receive(:staggered_deadline?).and_return(true)<br />
allow(TopicDueDate).to receive_message_chain(:find_by, :last, :due_at).and_return(1)<br />
expect(participant.stage_deadline).to eq("1")<br />
end<br />
end<br />
end<br />
end<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===Files method===<br />
The files method of AssignmentParticipant model is exactly the same as '''assignment_team.rb, L103''', so we move it to a module named Instance_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and AssignmentTeam model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Instance_method<br />
<br />
* module Instance_method<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = []<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each {|f| files << f }<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
===Self.import method===<br />
The self.import method of AssignmentParticipant model is exactly the same as '''course_participant.rb, L21''', so we move it to a module named Class_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and CourseParticipant model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Class_method<br />
<br />
def self.import(row, _row_header = nil, session, id)<br />
user = AssignmentParticipant.check_info_and_create(row, _row_header = nil, session)<br />
raise ImportError, "The assignment with id \"" + id.to_s + "\" was not found." if Assignment.find(id).nil?<br />
unless AssignmentParticipant.exists?(user_id: user.id, parent_id: id)<br />
new_part = AssignmentParticipant.create(user_id: user.id, parent_id: id)<br />
new_part.set_handle<br />
end<br />
end<br />
<br />
* module Class_method<br />
def check_info_and_create(row, _row_header = nil, session)<br />
raise ArgumentError, "No user id has been specified." if row.empty?<br />
user = User.find_by(name: row[0])<br />
if user.nil?<br />
raise ArgumentError, "The record containing #{row[0]} does not have enough items." if row.length < 4<br />
attributes = ImportFileHelper.define_attributes(row)<br />
user = ImportFileHelper.create_new_user(attributes, session)<br />
end<br />
end<br />
<br />
===Find_by method===<br />
Use '''find_by''' instead of dynamic method<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by(name:row[0])<br />
|-<br />
|}<br />
<br />
Use '''find_by''' instead of where.first<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109690CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T04:01:13Z<p>Cshao: /* Test Cases */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at using TFD(Test First Development) to refactor the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc.<br />
<br />
We used the TDF(Test First Development) method to refactor the AssignmentParticipant model. With the RSpec tool, we wrote 38 test cases for 24 methods in AssignmentParticipant model first. After finishing these test cases, we executed them, and most of them failed. And then we refactored the methods, '''scores''', '''files''', '''self.import''', '''find_by''', '''where.first''', and executed the test cases again, finally they all passed.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
describe AssignmentParticipant do<br />
let(:response) { build(:response) }<br />
let(:team) { build(:assignment_team, id: 1) }<br />
let(:team2) { build(:assignment_team, id: 2) }<br />
let(:response_map) { build(:review_response_map, reviewer_id: 2, response: [response]) }<br />
let(:participant) { build(:participant, id: 1, assignment: assignment) }<br />
let(:participant2) { build(:participant, id: 2, grade: 100) }<br />
let(:assignment) { build(:assignment, id: 1) }<br />
let(:review_questionnaire) { build(:questionnaire, id: 1) }<br />
let(:question) { double('Question') }<br />
let(:quiz_questionaire) { build(:questionnaire, id: 2) }<br />
let(:student) { build(:student, name: "student2064", fullname: "2064, student", handle: "handle") }<br />
let(:assignment_questionnaire) { build(:assignment_questionnaire) }<br />
let(:assignment_questionnaire2) { build(:assignment_questionnaire, used_in_round: 1) }<br />
let(:topic) { build(:topic) }<br />
before(:each) do<br />
allow(assignment).to receive(:questionnaires).and_return([review_questionnaire])<br />
allow(participant).to receive(:team).and_return(team)<br />
allow(participant).to receive(:user).and_return(student)<br />
allow(ResponseMap).to receive(:get_assessments_for).with(any_args).and_return([response])<br />
allow(SignedUpTeam).to receive(:topic_id).with(any_args).and_return(1)<br />
end<br />
<br />
describe '#dir_path' do<br />
it 'returns the directory path of current assignment' do<br />
expect(participant.dir_path).to eq "final_test"<br />
end<br />
end<br />
<br />
describe '#assign_quiz' do<br />
it 'creates a new QuizResponseMap record' do<br />
allow(QuizQuestionnaire).to receive(:find_by).with(instructor_id: 1).and_return(quiz_questionaire) # WHY CAN NOT DELETE THIS SENTENCE<br />
expect { participant.assign_quiz(participant, participant2, nil) }.to change { QuizResponseMap.count }.from(0).to(1)<br />
expect(participant.assign_quiz(participant, participant2, nil)).to be_an_instance_of(QuizResponseMap)<br />
end<br />
end<br />
<br />
describe '#reviewers' do<br />
it 'returns all the participants in this assignment who have reviewed the team where this participant belongs' do<br />
allow(ReviewResponseMap).to receive(:where).with(any_args).and_return([response_map]) # differences with .with(parameter)<br />
allow(AssignmentParticipant).to receive(:find).with(any_args).and_return(participant2)<br />
expect(participant.reviewers).to eq([participant2])<br />
end<br />
end<br />
<br />
describe '#review_score' do<br />
it 'returns the review score' do<br />
# diao yong de method tai duo le,er qie bu zhi dao sha yi si<br />
allow(review_questionnaire).to receive(:get_assessments_for).with(any_args).and_return([response])<br />
allow(review_questionnaire).to receive(:questions).and_return(question)<br />
allow(Answer).to receive(:compute_scores).with([response], question).and_return(avg: 100)<br />
allow(review_questionnaire).to receive(:max_possible_score).and_return(100)<br />
expect(participant.review_score).to eq(100)<br />
end<br />
end<br />
<br />
describe '#scores' do<br />
context 'when assignment is not varying rubric by round and not an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(false)<br />
allow(assignment).to receive(:is_microtask?).and_return(false)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
<br />
context 'when assignment is varying rubric by round but not an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(true)<br />
expect(participant).to receive(:merge_scores)<br />
allow(assignment).to receive(:is_microtask?).and_return(false)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
<br />
context 'when assignment is not varying rubric by round but an microtask' do<br />
it 'calculates scores that this participant has been given' do<br />
expect(participant).to receive(:assignment_questionnaires)<br />
expect(assignment).to receive(:compute_total_score)<br />
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(false)<br />
allow(assignment).to receive(:is_microtask?).and_return(true)<br />
expect(participant).to receive(:topic_total_scores)<br />
expect(assignment).to receive(:compute_total_score)<br />
expect(participant).to receive(:caculate_scores)<br />
participant.scores(question)<br />
end<br />
end<br />
end<br />
<br />
# included method<br />
describe '#assignment_questionnaires' do<br />
context 'when the round of questionnaire is nil' do<br />
it 'record the result as review scores' do<br />
scores = {}<br />
question_hash = {review: question}<br />
score_map = {max: 100, min: 100, avg: 100}<br />
allow(AssignmentQuestionnaire).to receive(:find_by).with(any_args).and_return(assignment_questionnaire)<br />
allow(review_questionnaire).to receive(:get_assessments_for).with(any_args).and_return([response])<br />
allow(Answer).to receive(:compute_scores).with(any_args).and_return(score_map)<br />
participant.assignment_questionnaires(question_hash, scores)<br />
expect(scores[:review][:assessments]).to eq([response])<br />
expect(scores[:review][:scores]).to eq(score_map)<br />
end<br />
end<br />
<br />
context 'when the round of questionnaire is not nil' do<br />
it 'record the result as review#{n} scores' do<br />
scores = {}<br />
question_hash = {review1: question}<br />
score_map = {max: 100, min: 100, avg: 100}<br />
allow(AssignmentQuestionnaire).to receive(:find_by).and_return(assignment_questionnaire2)<br />
allow(review_questionnaire).to receive(:get_assessments_round_for).with(any_args).and_return([response])<br />
allow(Answer).to receive(:compute_scores).with(any_args).and_return(score_map)<br />
participant.assignment_questionnaires(question_hash, scores)<br />
expect(scores[:review1][:assessments]).to eq([response])<br />
expect(scores[:review1][:scores]).to eq(score_map)<br />
end<br />
end<br />
end<br />
<br />
describe '#merge_scores' do<br />
context 'when all of the review_n are nil' do<br />
it 'set max, min, avg of review score as 0' do<br />
scores = {}<br />
allow(assignment).to receive(:num_review_rounds).and_return(1)<br />
participant.merge_scores(scores)<br />
expect(scores[:review][:scores][:max]).to eq(0)<br />
expect(scores[:review][:scores][:min]).to eq(0)<br />
expect(scores[:review][:scores][:min]).to eq(0)<br />
end<br />
end<br />
<br />
context 'when the review_n is not nil' do<br />
it 'merge the score of review_n to the score of review' do<br />
score_map = {max: 100, min: 100, avg: 100}<br />
scores = {review1: {scores: score_map, assessments: [response]}}<br />
allow(assignment).to receive(:num_review_rounds).and_return(1)<br />
participant.merge_scores(scores)<br />
expect(scores[:review][:scores][:max]).to eq(100)<br />
expect(scores[:review][:scores][:min]).to eq(100)<br />
expect(scores[:review][:scores][:min]).to eq(100)<br />
end<br />
end<br />
end<br />
<br />
describe '#topic_total_scores' do<br />
it 'set total_score and max_pts_available of score when topic is not nil' do<br />
scores = {total_score: 100}<br />
allow(SignUpTopic).to receive(:find_by).with(any_args).and_return(topic)<br />
participant.topic_total_scores(scores)<br />
expect(scores[:total_score]).to eq(0)<br />
expect(scores[:max_pts_available]).to eq(0)<br />
end<br />
end<br />
<br />
describe '#caculate_scores' do<br />
context 'when the participant has the grade' do<br />
it 'his total scores equals his grade' do<br />
scores = {}<br />
expect(participant2.caculate_scores(scores)).to eq(100.0)<br />
end<br />
end<br />
context 'when the participant has the grade and the total score more than 100' do<br />
it 'return the score of a given participant with total score 100' do<br />
scores = {total_score: 110}<br />
expect(participant.caculate_scores(scores)).to eq(total_score: 100)<br />
end<br />
end<br />
context 'when the participant has the grade and the total score less than 100' do<br />
it 'return the score of a given participant with total score' do<br />
scores = {total_score: 90}<br />
expect(participant.caculate_scores(scores)).to eq(total_score: 90)<br />
end<br />
end<br />
end<br />
<br />
describe '#copy' do<br />
it 'copies assignment participants to a certain course' do<br />
expect(participant.copy(517)).to be_an_instance_of(CourseParticipant)<br />
end<br />
end<br />
<br />
describe '#feedback' do<br />
it 'returns corrsponding author feedback responses given by current participant' do<br />
expect(participant.feedback).to eq([response])<br />
end<br />
end<br />
<br />
describe '#reviews' do<br />
it 'returns corrsponding peer review responses given by current team' do<br />
expect(participant.reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#reviews_by_reviewer' do<br />
it 'returns corrsponding peer review responses given by certain reviewer' do<br />
allow(ReviewResponseMap).to receive(:get_reviewer_assessments_for).with(team, participant2).and_return([response])<br />
expect(participant.reviews_by_reviewer(participant2)).to eq([response])<br />
end<br />
end<br />
<br />
describe '#quizzes_taken' do<br />
it 'returns corrsponding quiz responses given by current participant' do<br />
expect(participant.quizzes_taken).to eq([response])<br />
end<br />
end<br />
<br />
describe '#metareviews' do<br />
it 'returns corrsponding metareview responses given by current participant' do<br />
expect(participant.metareviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#teammate_reviews' do<br />
it 'returns corrsponding teammate review responses given by current participant' do<br />
expect(participant.teammate_reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#bookmark_reviews' do<br />
it 'returns corrsponding bookmark review responses given by current participant' do<br />
expect(participant.bookmark_reviews).to eq([response])<br />
end<br />
end<br />
<br />
describe '#files' do<br />
context 'when there is not subdirectory in current directory' do<br />
it 'returns all files in current directory' do<br />
allow(Dir).to receive(:[]).with("a/*").and_return(["a/k.rb"])<br />
allow(File).to receive(:directory?).with("a/k.rb").and_return(false)<br />
expect(participant.files("a")).to eq(["a/k.rb"])<br />
end<br />
end<br />
<br />
context 'when there is subdirectory in current directory' do<br />
it 'recursively returns all files in current directory' do<br />
allow(Dir).to receive(:[]).with("a/*").and_return(["a/b"])<br />
allow(File).to receive(:directory?).with("a/b").and_return(true)<br />
allow(Dir).to receive(:[]).with("a/b/*").and_return(["a/b/k.rb"])<br />
allow(File).to receive(:directory?).with("a/b/k.rb").and_return(false)<br />
expect(participant.files("a")).to eq(["a/b/k.rb", "a/b"])<br />
end<br />
end<br />
end<br />
<br />
describe ".import" do<br />
context 'when record is empty' do<br />
it 'raises an ArgumentError' do<br />
row = []<br />
allow(AssignmentParticipant).to receive(:check_info_and_create).with(any_args).and_raise("No user id has been specified.")<br />
expect(AssignmentParticipant).to receive(:check_info_and_create)<br />
expect { AssignmentParticipant.import(row, nil, nil, nil) }.to raise_error("No user id has been specified.")<br />
end<br />
end<br />
<br />
context 'when no user is found by offered username' do<br />
context 'when the record has less than 4 items' do<br />
it 'raises an ArgumentError' do<br />
row = ["user_name", "user_fullname", "name@email.com"]<br />
allow(AssignmentParticipant).<br />
to receive(:check_info_and_create).with(any_args).and_raise("The record containing #{row[0]} does not have enough items.")<br />
expect(AssignmentParticipant).to receive(:check_info_and_create)<br />
expect { AssignmentParticipant.import(row, nil, nil, nil) }.to raise_error("The record containing #{row[0]} does not have enough items.")<br />
end<br />
end<br />
<br />
context 'when the record has more than 4 items' do<br />
context 'when certain assignment cannot be found' do<br />
it 'creates a new user based on import information and raises an ImportError' do<br />
row = ["user_name", "user_fullname", "name@email.com", "user_role_name", "user_parent_name"]<br />
session = {user: participant}<br />
allow(User).to receive(:find_by).with(any_args).and_return(nil)<br />
allow(Assignment).to receive(:find).with(2).and_return(nil)<br />
expect { AssignmentParticipant.import(row, nil, session, 2) }.<br />
to raise_error("The assignment with id \"2\" was not found.").and change { User.count }.by(1)<br />
end<br />
end<br />
<br />
context 'when certain assignment can be found and assignment participant does not exists' do<br />
it 'creates a new user, new participant and raises an ImportError' do<br />
row = ["user_name", "user_fullname", "name@email.com", "user_role_name", "user_parent_name"]<br />
session = {user: participant}<br />
allow(User).to receive(:find_by_name).with(any_args).and_return(nil)<br />
allow(Assignment).to receive(:find).with(2).and_return(assignment)<br />
allow(AssignmentParticipant).to receive(:exists?).and_return(false)<br />
expect { AssignmentParticipant.import(row, nil, session, 2) }.to change { User.count }.by(1).and change { AssignmentParticipant.count }.by(1)<br />
end<br />
end<br />
end<br />
end<br />
end<br />
<br />
describe '.export' do<br />
it 'exports all participants in current assignment' do<br />
csv = []<br />
expect(AssignmentParticipant).to receive_message_chain(:where, :find_each).with(any_args).and_yield(participant)<br />
expect(AssignmentParticipant.export(csv, 1, any_args)).<br />
to eq([["student2064", "2064, student", "expertiza@mailinator.com", "Student", "instructor6", true, true, true, "handle"]])<br />
end<br />
end<br />
<br />
describe '#set_handle' do<br />
context 'when the user of current participant does not have handle' do<br />
it 'sets the user name as the handle of current participant' do<br />
allow(student).to receive_message_chain(:handle, :nil?).and_return(true)<br />
allow(student).to receive(:handle).and_return("")<br />
participant.set_handle<br />
expect(participant.handle).to eq("student2064")<br />
end<br />
end<br />
<br />
context 'when current assignment exists participants with same handle as the one of current user' do<br />
it 'sets the user name as the name of current participant' do<br />
allow(AssignmentParticipant).to receive(:exists?).with(any_args).and_return(true)<br />
participant.set_handle<br />
expect(participant.handle).to eq("student2064")<br />
end<br />
end<br />
<br />
context 'when current assignment does not have participants with same handle as the one of current user' do<br />
it 'sets the user name as the handle of current participant' do<br />
participant.set_handle<br />
expect(participant.handle).to eq("handle")<br />
end<br />
end<br />
end<br />
<br />
describe '#review_file_path' do<br />
it 'returns the file path for reviewer to upload files during peer review' do<br />
allow(ResponseMap).to receive(:find).with(any_args).and_return(response_map)<br />
allow(TeamsUser).to receive_message_chain(:find_by, :user_id).with(any_args).and_return(1)<br />
allow(Participant).to receive(:find_by).with(any_args).and_return(participant)<br />
file_path = Rails.root.to_s + "/pg_data/instructor6/csc517/test/final_test/0_review/1"<br />
expect(participant.review_file_path(1)).to eq(file_path)<br />
end<br />
end<br />
<br />
describe '#current_stage' do<br />
it 'returns stage of current assignment' do<br />
allow(assignment).to receive(:get_current_stage).with(1).and_return("Finished")<br />
expect(participant.current_stage).to eq("Finished")<br />
end<br />
end<br />
<br />
describe '#stage_deadline' do<br />
context 'when stage of current assignment is not Finished' do<br />
it 'returns current stage' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Unknow")<br />
expect(participant.stage_deadline).to eq("Unknow")<br />
end<br />
end<br />
<br />
context 'when stage of current assignment not Finished' do<br />
context 'current assignment is not a staggered deadline assignment' do<br />
it 'returns the due date of current assignment' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Finished")<br />
allow(assignment).to receive(:staggered_deadline?).and_return(false)<br />
allow(assignment).to receive_message_chain(:due_dates, :last, :due_at).and_return(1)<br />
expect(participant.stage_deadline).to eq("1")<br />
end<br />
end<br />
<br />
context 'current assignment is a staggered deadline assignment' do<br />
it 'returns the due date of current topic' do<br />
allow(assignment).to receive(:stage_deadline).with(1).and_return("Finished")<br />
allow(assignment).to receive(:staggered_deadline?).and_return(true)<br />
allow(TopicDueDate).to receive_message_chain(:find_by, :last, :due_at).and_return(1)<br />
expect(participant.stage_deadline).to eq("1")<br />
end<br />
end<br />
end<br />
end<br />
end<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===Files method===<br />
The files method of AssignmentParticipant model is exactly the same as '''assignment_team.rb, L103''', so we move it to a module named Instance_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and AssignmentTeam model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Instance_method<br />
<br />
* module Instance_method<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = []<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each {|f| files << f }<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
===Self.import method===<br />
The self.import method of AssignmentParticipant model is exactly the same as '''course_participant.rb, L21''', so we move it to a module named Class_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and CourseParticipant model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Class_method<br />
<br />
def self.import(row, _row_header = nil, session, id)<br />
user = AssignmentParticipant.check_info_and_create(row, _row_header = nil, session)<br />
raise ImportError, "The assignment with id \"" + id.to_s + "\" was not found." if Assignment.find(id).nil?<br />
unless AssignmentParticipant.exists?(user_id: user.id, parent_id: id)<br />
new_part = AssignmentParticipant.create(user_id: user.id, parent_id: id)<br />
new_part.set_handle<br />
end<br />
end<br />
<br />
* module Class_method<br />
def check_info_and_create(row, _row_header = nil, session)<br />
raise ArgumentError, "No user id has been specified." if row.empty?<br />
user = User.find_by(name: row[0])<br />
if user.nil?<br />
raise ArgumentError, "The record containing #{row[0]} does not have enough items." if row.length < 4<br />
attributes = ImportFileHelper.define_attributes(row)<br />
user = ImportFileHelper.create_new_user(attributes, session)<br />
end<br />
end<br />
<br />
===Find_by method===<br />
Use '''find_by''' instead of dynamic method<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by(name:row[0])<br />
|-<br />
|}<br />
<br />
Use '''find_by''' instead of where.first<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109687CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T04:00:10Z<p>Cshao: </p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at using TFD(Test First Development) to refactor the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc.<br />
<br />
We used the TDF(Test First Development) method to refactor the AssignmentParticipant model. With the RSpec tool, we wrote 38 test cases for 24 methods in AssignmentParticipant model first. After finishing these test cases, we executed them, and most of them failed. And then we refactored the methods, '''scores''', '''files''', '''self.import''', '''find_by''', '''where.first''', and executed the test cases again, finally they all passed.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===Files method===<br />
The files method of AssignmentParticipant model is exactly the same as '''assignment_team.rb, L103''', so we move it to a module named Instance_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and AssignmentTeam model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Instance_method<br />
<br />
* module Instance_method<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = []<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each {|f| files << f }<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
===Self.import method===<br />
The self.import method of AssignmentParticipant model is exactly the same as '''course_participant.rb, L21''', so we move it to a module named Class_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and CourseParticipant model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Class_method<br />
<br />
def self.import(row, _row_header = nil, session, id)<br />
user = AssignmentParticipant.check_info_and_create(row, _row_header = nil, session)<br />
raise ImportError, "The assignment with id \"" + id.to_s + "\" was not found." if Assignment.find(id).nil?<br />
unless AssignmentParticipant.exists?(user_id: user.id, parent_id: id)<br />
new_part = AssignmentParticipant.create(user_id: user.id, parent_id: id)<br />
new_part.set_handle<br />
end<br />
end<br />
<br />
* module Class_method<br />
def check_info_and_create(row, _row_header = nil, session)<br />
raise ArgumentError, "No user id has been specified." if row.empty?<br />
user = User.find_by(name: row[0])<br />
if user.nil?<br />
raise ArgumentError, "The record containing #{row[0]} does not have enough items." if row.length < 4<br />
attributes = ImportFileHelper.define_attributes(row)<br />
user = ImportFileHelper.create_new_user(attributes, session)<br />
end<br />
end<br />
<br />
===Find_by method===<br />
Use '''find_by''' instead of dynamic method<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by(name:row[0])<br />
|-<br />
|}<br />
<br />
Use '''find_by''' instead of where.first<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109666CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T03:45:12Z<p>Cshao: /* Files method */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===Files method===<br />
The files method of AssignmentParticipant model is exactly the same as '''assignment_team.rb, L103''', so we move it to a module named Instance_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and AssignmentTeam model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Instance_method<br />
<br />
* module Instance_method<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = []<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each {|f| files << f }<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
===Self.import method===<br />
The self.import method of AssignmentParticipant model is exactly the same as '''course_participant.rb, L21''', so we move it to a module named Class_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and CourseParticipant model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Class_method<br />
<br />
def self.import(row, _row_header = nil, session, id)<br />
user = AssignmentParticipant.check_info_and_create(row, _row_header = nil, session)<br />
raise ImportError, "The assignment with id \"" + id.to_s + "\" was not found." if Assignment.find(id).nil?<br />
unless AssignmentParticipant.exists?(user_id: user.id, parent_id: id)<br />
new_part = AssignmentParticipant.create(user_id: user.id, parent_id: id)<br />
new_part.set_handle<br />
end<br />
end<br />
<br />
* module Class_method<br />
def check_info_and_create(row, _row_header = nil, session)<br />
raise ArgumentError, "No user id has been specified." if row.empty?<br />
user = User.find_by(name: row[0])<br />
if user.nil?<br />
raise ArgumentError, "The record containing #{row[0]} does not have enough items." if row.length < 4<br />
attributes = ImportFileHelper.define_attributes(row)<br />
user = ImportFileHelper.create_new_user(attributes, session)<br />
end<br />
end<br />
<br />
===Find_by method===<br />
Use '''find_by''' instead of dynamic method<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by(name:row[0])<br />
|-<br />
|}<br />
<br />
Use '''find_by''' instead of where.first<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109660CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T03:32:11Z<p>Cshao: /* Files method */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===Files method===<br />
The files method of AssignmentParticipant model is exactly the same as '''assignment_team.rb, L103''', so we move it to a module named Instance_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and AssignmentTeam model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Instance_method<br />
<br />
* module Instance_method<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = []<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each {|f| files << f }<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
===Files method===<br />
The files method of AssignmentParticipant model is exactly the same as '''assignment_team.rb, L103''', so we move it to a module named Instance_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and AssignmentTeam model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Instance_method<br />
<br />
* module Instance_method<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = []<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each {|f| files << f }<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
===Find_by method===<br />
Use '''find_by''' instead of dynamic method<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by(name:row[0])<br />
|-<br />
|}<br />
<br />
Use '''find_by''' instead of where.first<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109659CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T03:30:31Z<p>Cshao: /* Files method */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===Files method===<br />
The files method of AssignmentParticipant model is exactly the same as '''assignment_team.rb, L103''', so we move it to a module named Instance_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and AssignmentTeam model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Instance_method<br />
<br />
* module Instance_method<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = []<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each {|f| files << f }<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
===Find_by method===<br />
Use '''find_by''' instead of dynamic method<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by(name:row[0])<br />
|-<br />
|}<br />
<br />
Use '''find_by''' instead of where.first<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109658CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T03:29:58Z<p>Cshao: /* Find_by methods */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===Files method===<br />
The files method of AssignmentParticipant model is exactly the same as '''assignment_team.rb, L103''', so we move it to a module named Instance_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and AssignmentTeam model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Instance_method<br />
<br />
* module Instance_method<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = []<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each {|f| files << f }<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
end<br />
<br />
===Find_by method===<br />
Use '''find_by''' instead of dynamic method<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by(name:row[0])<br />
|-<br />
|}<br />
<br />
Use '''find_by''' instead of where.first<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109657CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T03:29:28Z<p>Cshao: /* Files method */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===Files method===<br />
The files method of AssignmentParticipant model is exactly the same as '''assignment_team.rb, L103''', so we move it to a module named Instance_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and AssignmentTeam model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Instance_method<br />
<br />
* module Instance_method<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = []<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each {|f| files << f }<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
end<br />
<br />
===Find_by methods===<br />
Use '''find_by''' instead of dynamic method<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by(name:row[0])<br />
|-<br />
|}<br />
<br />
Use '''find_by''' instead of where.first<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109656CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T03:29:03Z<p>Cshao: /* Files method */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===Files method===<br />
The files method of AssignmentParticipant model is exactly the same as '''assignment_team.rb, L103''', so we move it to a module named Instance_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and AssignmentTeam model.<br />
<br />
require 'TFD1770_refactor'<br />
<br />
include Instance_method<br />
<br />
* module Instance_metho<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = []<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each {|f| files << f }<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
end<br />
<br />
===Find_by methods===<br />
Use '''find_by''' instead of dynamic method<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by(name:row[0])<br />
|-<br />
|}<br />
<br />
Use '''find_by''' instead of where.first<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109655CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T03:28:47Z<p>Cshao: /* Files method */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===Files method===<br />
The files method of AssignmentParticipant model is exactly the same as '''assignment_team.rb, L103''', so we move it to a module named Instance_method in '''lib/TFD1770_refactor.rb'''.<br />
The below two lines are added to the AssignmentParticipant model and AssignmentTeam model.<br />
<br />
<br />
<br />
require 'TFD1770_refactor'<br />
include Instance_method<br />
<br />
* module Instance_metho<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = []<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each {|f| files << f }<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
end<br />
<br />
===Find_by methods===<br />
Use '''find_by''' instead of dynamic method<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by(name:row[0])<br />
|-<br />
|}<br />
<br />
Use '''find_by''' instead of where.first<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109654CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T03:19:59Z<p>Cshao: /* Files method */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===Files method===<br />
The files method of AssignmentParticipant model has been moved to a module named Instance_method in '''lib/TFD1770_refactor.rb'''.<br />
The below line was added to the AssignmentParticipant model.<br />
<br />
require 'TFD1770_refactor'<br />
include Instance_method<br />
<br />
* module Instance_metho<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = []<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each {|f| files << f }<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
end<br />
<br />
===Find_by methods===<br />
Use '''find_by''' instead of dynamic method<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by(name:row[0])<br />
|-<br />
|}<br />
<br />
Use '''find_by''' instead of where.first<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109653CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T03:19:22Z<p>Cshao: /* Files method */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===Files method===<br />
The files method of AssignmentParticipant model has been moved to a module named Instance_method in '''lib/TFD1770_refactor.rb'''.<br />
The below line was added to the AssignmentParticipant model.<br />
require 'TFD1770_refactor'<br />
include Instance_method<br />
<br />
* module Instance_metho<br />
<br />
module Instance_method<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = []<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each {|f| files << f }<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
end<br />
<br />
===Find_by methods===<br />
Use '''find_by''' instead of dynamic method<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by(name:row[0])<br />
|-<br />
|}<br />
<br />
Use '''find_by''' instead of where.first<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109652CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T03:18:53Z<p>Cshao: /* Files method */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===Files method===<br />
The files method of AssignmentParticipant model has been moved to a module named Instance_method in the lib directory '''lib/TFD1770_refactor.rb'''.<br />
The below line was added to the AssignmentParticipant model.<br />
require 'TFD1770_refactor'<br />
include Instance_method<br />
<br />
* module Instance_metho<br />
<br />
module Instance_method<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = []<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each {|f| files << f }<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
end<br />
<br />
===Find_by methods===<br />
Use '''find_by''' instead of dynamic method<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by(name:row[0])<br />
|-<br />
|}<br />
<br />
Use '''find_by''' instead of where.first<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109651CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T03:16:40Z<p>Cshao: /* Files method */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===Files method===<br />
The files method of AssignmentParticipant model have been moved to the lib directory '''lib/TFD1770_refactor.rb'''.<br />
The below line was added to the AssignmentParticipant model.<br />
include FileHelper<br />
<br />
The AssignmentParticipant class would look like<br />
require 'TFD1770_refactor'<br />
include Instance_method<br />
<br />
Methods moved to FileHelper:<br />
<br />
* submitted_files<br />
<br />
def submitted_files<br />
files(self.path) if self.directory_num<br />
end<br />
<br />
* files(directory)<br />
<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = Array.new<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each{|f| files << f}<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
* submitted_files()<br />
<br />
def submitted_files()<br />
files = Array.new<br />
if(self.directory_num)<br />
files = files(self.path)<br />
end<br />
return files<br />
end<br />
<br />
* dir_path<br />
<br />
def dir_path<br />
assignment.try :directory_path<br />
end<br />
<br />
===Find_by methods===<br />
Use '''find_by''' instead of dynamic method<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by(name:row[0])<br />
|-<br />
|}<br />
<br />
Use '''find_by''' instead of where.first<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109650CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T03:15:10Z<p>Cshao: /* File and directory methods */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===Files method===<br />
The files method of AssignmentParticipant model have been moved to the lib directory '''lib/TFD1770_refactor.rb'''.<br />
The below line was added to the AssignmentParticipant model.<br />
include FileHelper<br />
<br />
The AssignmentParticipant class would look like<br />
class AssignmentParticipant < Participant<br />
require 'wiki_helper'<br />
'''include FileHelper'''<br />
Methods moved to FileHelper:<br />
<br />
* submitted_files<br />
<br />
def submitted_files<br />
files(self.path) if self.directory_num<br />
end<br />
<br />
* files(directory)<br />
<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = Array.new<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each{|f| files << f}<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
* submitted_files()<br />
<br />
def submitted_files()<br />
files = Array.new<br />
if(self.directory_num)<br />
files = files(self.path)<br />
end<br />
return files<br />
end<br />
<br />
* dir_path<br />
<br />
def dir_path<br />
assignment.try :directory_path<br />
end<br />
<br />
===Find_by methods===<br />
Use '''find_by''' instead of dynamic method<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by(name:row[0])<br />
|-<br />
|}<br />
<br />
Use '''find_by''' instead of where.first<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109649CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T03:11:39Z<p>Cshao: /* Review methods */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===File and directory methods===<br />
The files and directory methods from AssignmentParticipant model have been moved to the '''FileHelper''' module.<br />
The methods '''files''', '''submitted_files''' and '''dir_path''' are appropriate for the '''FileHelper' module and hence been moved there.<br />
The below line was added to the AssignmentParticipant model.<br />
include FileHelper<br />
<br />
The AssignmentParticipant class would look like<br />
class AssignmentParticipant < Participant<br />
require 'wiki_helper'<br />
'''include FileHelper'''<br />
Methods moved to FileHelper:<br />
<br />
* submitted_files<br />
<br />
def submitted_files<br />
files(self.path) if self.directory_num<br />
end<br />
<br />
* files(directory)<br />
<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = Array.new<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each{|f| files << f}<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
* submitted_files()<br />
<br />
def submitted_files()<br />
files = Array.new<br />
if(self.directory_num)<br />
files = files(self.path)<br />
end<br />
return files<br />
end<br />
<br />
* dir_path<br />
<br />
def dir_path<br />
assignment.try :directory_path<br />
end<br />
<br />
===Find_by methods===<br />
Use '''find_by''' instead of dynamic method<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by(name:row[0])<br />
|-<br />
|}<br />
<br />
Use '''find_by''' instead of where.first<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109648CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T03:10:46Z<p>Cshao: /* Review methods */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===File and directory methods===<br />
The files and directory methods from AssignmentParticipant model have been moved to the '''FileHelper''' module.<br />
The methods '''files''', '''submitted_files''' and '''dir_path''' are appropriate for the '''FileHelper' module and hence been moved there.<br />
The below line was added to the AssignmentParticipant model.<br />
include FileHelper<br />
<br />
The AssignmentParticipant class would look like<br />
class AssignmentParticipant < Participant<br />
require 'wiki_helper'<br />
'''include FileHelper'''<br />
Methods moved to FileHelper:<br />
<br />
* submitted_files<br />
<br />
def submitted_files<br />
files(self.path) if self.directory_num<br />
end<br />
<br />
* files(directory)<br />
<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = Array.new<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each{|f| files << f}<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
* submitted_files()<br />
<br />
def submitted_files()<br />
files = Array.new<br />
if(self.directory_num)<br />
files = files(self.path)<br />
end<br />
return files<br />
end<br />
<br />
* dir_path<br />
<br />
def dir_path<br />
assignment.try :directory_path<br />
end<br />
<br />
===Review methods===<br />
Use '''find_by''' instead of dynamic method<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by(name:row[0])<br />
|-<br />
|}<br />
<br />
Use '''find_by''' instead of where.first<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109647CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T03:03:27Z<p>Cshao: /* Review methods */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===File and directory methods===<br />
The files and directory methods from AssignmentParticipant model have been moved to the '''FileHelper''' module.<br />
The methods '''files''', '''submitted_files''' and '''dir_path''' are appropriate for the '''FileHelper' module and hence been moved there.<br />
The below line was added to the AssignmentParticipant model.<br />
include FileHelper<br />
<br />
The AssignmentParticipant class would look like<br />
class AssignmentParticipant < Participant<br />
require 'wiki_helper'<br />
'''include FileHelper'''<br />
Methods moved to FileHelper:<br />
<br />
* submitted_files<br />
<br />
def submitted_files<br />
files(self.path) if self.directory_num<br />
end<br />
<br />
* files(directory)<br />
<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = Array.new<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each{|f| files << f}<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
* submitted_files()<br />
<br />
def submitted_files()<br />
files = Array.new<br />
if(self.directory_num)<br />
files = files(self.path)<br />
end<br />
return files<br />
end<br />
<br />
* dir_path<br />
<br />
def dir_path<br />
assignment.try :directory_path<br />
end<br />
<br />
===Review methods===<br />
The bookmark_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''BookmarkRatingQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by(name:row[0])<br />
|-<br />
|}<br />
<br />
* The teammate_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''TeammateReviewQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109646CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T02:56:16Z<p>Cshao: /* Review methods */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===File and directory methods===<br />
The files and directory methods from AssignmentParticipant model have been moved to the '''FileHelper''' module.<br />
The methods '''files''', '''submitted_files''' and '''dir_path''' are appropriate for the '''FileHelper' module and hence been moved there.<br />
The below line was added to the AssignmentParticipant model.<br />
include FileHelper<br />
<br />
The AssignmentParticipant class would look like<br />
class AssignmentParticipant < Participant<br />
require 'wiki_helper'<br />
'''include FileHelper'''<br />
Methods moved to FileHelper:<br />
<br />
* submitted_files<br />
<br />
def submitted_files<br />
files(self.path) if self.directory_num<br />
end<br />
<br />
* files(directory)<br />
<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = Array.new<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each{|f| files << f}<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
* submitted_files()<br />
<br />
def submitted_files()<br />
files = Array.new<br />
if(self.directory_num)<br />
files = files(self.path)<br />
end<br />
return files<br />
end<br />
<br />
* dir_path<br />
<br />
def dir_path<br />
assignment.try :directory_path<br />
end<br />
<br />
===Review methods===<br />
The bookmark_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''BookmarkRatingQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L34<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
<br />
* assignment_particpant.rb L134<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
<br />
* TFD1770_refactor.rb L20<br />
user = User.find_by_name(row[0])<br />
|-<br />
|}<br />
<br />
* The teammate_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''TeammateReviewQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|<br />
* assignment_particpant.rb L267<br />
first_user_id = TeamsUser.where(team_id: response_map.reviewee_id).first.user_id<br />
<br />
* assignment_particpant.rb L267<br />
participant = Participant.where(parent_id: response_map.reviewed_object_id, user_id: first_user_id).first<br />
<br />
||<br />
* assignment_particpant.rb L258<br />
first_user_id = TeamsUser.find_by(team_id: response_map.reviewee_id).user_id<br />
<br />
* assignment_particpant.rb L259<br />
participant = Participant.find_by(parent_id: response_map.reviewed_object_id, user_id: first_user_id)<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109642CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T02:48:22Z<p>Cshao: /* Review methods */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===File and directory methods===<br />
The files and directory methods from AssignmentParticipant model have been moved to the '''FileHelper''' module.<br />
The methods '''files''', '''submitted_files''' and '''dir_path''' are appropriate for the '''FileHelper' module and hence been moved there.<br />
The below line was added to the AssignmentParticipant model.<br />
include FileHelper<br />
<br />
The AssignmentParticipant class would look like<br />
class AssignmentParticipant < Participant<br />
require 'wiki_helper'<br />
'''include FileHelper'''<br />
Methods moved to FileHelper:<br />
<br />
* submitted_files<br />
<br />
def submitted_files<br />
files(self.path) if self.directory_num<br />
end<br />
<br />
* files(directory)<br />
<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = Array.new<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each{|f| files << f}<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
* submitted_files()<br />
<br />
def submitted_files()<br />
files = Array.new<br />
if(self.directory_num)<br />
files = files(self.path)<br />
end<br />
return files<br />
end<br />
<br />
* dir_path<br />
<br />
def dir_path<br />
assignment.try :directory_path<br />
end<br />
<br />
===Review methods===<br />
The bookmark_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''BookmarkRatingQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
<br />
|| <br />
* assignment_particpant.rb L32<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
<br />
* assignment_particpant.rb L113<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
<br />
* assignment_particpant.rb L196<br />
user = User.find_by_name(row[0])<br />
|-<br />
|}<br />
<br />
* The teammate_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''TeammateReviewQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def teammate_reviews<br />
TeammateReviewResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
TeammateReviewResponseMap.get_assessments_for(participant) #participant.teammate_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109641CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T02:43:47Z<p>Cshao: /* Review methods */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===File and directory methods===<br />
The files and directory methods from AssignmentParticipant model have been moved to the '''FileHelper''' module.<br />
The methods '''files''', '''submitted_files''' and '''dir_path''' are appropriate for the '''FileHelper' module and hence been moved there.<br />
The below line was added to the AssignmentParticipant model.<br />
include FileHelper<br />
<br />
The AssignmentParticipant class would look like<br />
class AssignmentParticipant < Participant<br />
require 'wiki_helper'<br />
'''include FileHelper'''<br />
Methods moved to FileHelper:<br />
<br />
* submitted_files<br />
<br />
def submitted_files<br />
files(self.path) if self.directory_num<br />
end<br />
<br />
* files(directory)<br />
<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = Array.new<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each{|f| files << f}<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
* submitted_files()<br />
<br />
def submitted_files()<br />
files = Array.new<br />
if(self.directory_num)<br />
files = files(self.path)<br />
end<br />
return files<br />
end<br />
<br />
* dir_path<br />
<br />
def dir_path<br />
assignment.try :directory_path<br />
end<br />
<br />
===Review methods===<br />
The bookmark_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''BookmarkRatingQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| * def assign_quiz(contributor, reviewer, _topic = nil)<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
QuizResponseMap.create(reviewed_object_id: quiz.try(:id), reviewee_id: contributor.id, reviewer_id: reviewer.id)<br />
end<br />
<br />
|| <br />
* def assign_quiz(contributor, reviewer, _topic = nil)<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
QuizResponseMap.create(reviewed_object_id: quiz.try(:id), reviewee_id: contributor.id, reviewer_id: reviewer.id)<br />
end<br />
|-<br />
|}<br />
<br />
* The teammate_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''TeammateReviewQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def teammate_reviews<br />
TeammateReviewResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
TeammateReviewResponseMap.get_assessments_for(participant) #participant.teammate_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109640CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T02:42:59Z<p>Cshao: /* Review methods */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===File and directory methods===<br />
The files and directory methods from AssignmentParticipant model have been moved to the '''FileHelper''' module.<br />
The methods '''files''', '''submitted_files''' and '''dir_path''' are appropriate for the '''FileHelper' module and hence been moved there.<br />
The below line was added to the AssignmentParticipant model.<br />
include FileHelper<br />
<br />
The AssignmentParticipant class would look like<br />
class AssignmentParticipant < Participant<br />
require 'wiki_helper'<br />
'''include FileHelper'''<br />
Methods moved to FileHelper:<br />
<br />
* submitted_files<br />
<br />
def submitted_files<br />
files(self.path) if self.directory_num<br />
end<br />
<br />
* files(directory)<br />
<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = Array.new<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each{|f| files << f}<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
* submitted_files()<br />
<br />
def submitted_files()<br />
files = Array.new<br />
if(self.directory_num)<br />
files = files(self.path)<br />
end<br />
return files<br />
end<br />
<br />
* dir_path<br />
<br />
def dir_path<br />
assignment.try :directory_path<br />
end<br />
<br />
===Review methods===<br />
The bookmark_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''BookmarkRatingQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| * def assign_quiz(contributor, reviewer, _topic = nil)<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
QuizResponseMap.create(reviewed_object_id: quiz.try(:id), reviewee_id: contributor.id, reviewer_id: reviewer.id)<br />
end<br />
<br />
|| * def assign_quiz(contributor, reviewer, _topic = nil)<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
QuizResponseMap.create(reviewed_object_id: quiz.try(:id), reviewee_id: contributor.id, reviewer_id: reviewer.id)<br />
end<br />
|-<br />
|}<br />
<br />
* The teammate_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''TeammateReviewQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def teammate_reviews<br />
TeammateReviewResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
TeammateReviewResponseMap.get_assessments_for(participant) #participant.teammate_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109639CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T02:41:20Z<p>Cshao: /* Review methods */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===File and directory methods===<br />
The files and directory methods from AssignmentParticipant model have been moved to the '''FileHelper''' module.<br />
The methods '''files''', '''submitted_files''' and '''dir_path''' are appropriate for the '''FileHelper' module and hence been moved there.<br />
The below line was added to the AssignmentParticipant model.<br />
include FileHelper<br />
<br />
The AssignmentParticipant class would look like<br />
class AssignmentParticipant < Participant<br />
require 'wiki_helper'<br />
'''include FileHelper'''<br />
Methods moved to FileHelper:<br />
<br />
* submitted_files<br />
<br />
def submitted_files<br />
files(self.path) if self.directory_num<br />
end<br />
<br />
* files(directory)<br />
<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = Array.new<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each{|f| files << f}<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
* submitted_files()<br />
<br />
def submitted_files()<br />
files = Array.new<br />
if(self.directory_num)<br />
files = files(self.path)<br />
end<br />
return files<br />
end<br />
<br />
* dir_path<br />
<br />
def dir_path<br />
assignment.try :directory_path<br />
end<br />
<br />
===Review methods===<br />
* The bookmark_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''BookmarkRatingQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def assign_quiz(contributor, reviewer, _topic = nil)<br />
quiz = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
QuizResponseMap.create(reviewed_object_id: quiz.try(:id), reviewee_id: contributor.id, reviewer_id: reviewer.id)<br />
end<br />
<br />
|| def assign_quiz(contributor, reviewer, _topic = nil)<br />
quiz = QuizQuestionnaire.find_by(instructor_id: contributor.id)<br />
QuizResponseMap.create(reviewed_object_id: quiz.try(:id), reviewee_id: contributor.id, reviewer_id: reviewer.id)<br />
end<br />
|-<br />
|}<br />
<br />
* The teammate_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''TeammateReviewQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def teammate_reviews<br />
TeammateReviewResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
TeammateReviewResponseMap.get_assessments_for(participant) #participant.teammate_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109637CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T02:38:07Z<p>Cshao: /* Remove unused methods */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===File and directory methods===<br />
The files and directory methods from AssignmentParticipant model have been moved to the '''FileHelper''' module.<br />
The methods '''files''', '''submitted_files''' and '''dir_path''' are appropriate for the '''FileHelper' module and hence been moved there.<br />
The below line was added to the AssignmentParticipant model.<br />
include FileHelper<br />
<br />
The AssignmentParticipant class would look like<br />
class AssignmentParticipant < Participant<br />
require 'wiki_helper'<br />
'''include FileHelper'''<br />
Methods moved to FileHelper:<br />
<br />
* submitted_files<br />
<br />
def submitted_files<br />
files(self.path) if self.directory_num<br />
end<br />
<br />
* files(directory)<br />
<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = Array.new<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each{|f| files << f}<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
* submitted_files()<br />
<br />
def submitted_files()<br />
files = Array.new<br />
if(self.directory_num)<br />
files = files(self.path)<br />
end<br />
return files<br />
end<br />
<br />
* dir_path<br />
<br />
def dir_path<br />
assignment.try :directory_path<br />
end<br />
<br />
===Review methods===<br />
* The bookmark_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''BookmarkRatingQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def bookmark_reviews<br />
BookmarkRatingResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
BookmarkRatingResponseMap.get_assessments_for(participant) # participant.bookmark_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
* The teammate_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''TeammateReviewQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def teammate_reviews<br />
TeammateReviewResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
TeammateReviewResponseMap.get_assessments_for(participant) #participant.teammate_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109636CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T02:37:43Z<p>Cshao: /* set_handle method */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===File and directory methods===<br />
The files and directory methods from AssignmentParticipant model have been moved to the '''FileHelper''' module.<br />
The methods '''files''', '''submitted_files''' and '''dir_path''' are appropriate for the '''FileHelper' module and hence been moved there.<br />
The below line was added to the AssignmentParticipant model.<br />
include FileHelper<br />
<br />
The AssignmentParticipant class would look like<br />
class AssignmentParticipant < Participant<br />
require 'wiki_helper'<br />
'''include FileHelper'''<br />
Methods moved to FileHelper:<br />
<br />
* submitted_files<br />
<br />
def submitted_files<br />
files(self.path) if self.directory_num<br />
end<br />
<br />
* files(directory)<br />
<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = Array.new<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each{|f| files << f}<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
* submitted_files()<br />
<br />
def submitted_files()<br />
files = Array.new<br />
if(self.directory_num)<br />
files = files(self.path)<br />
end<br />
return files<br />
end<br />
<br />
* dir_path<br />
<br />
def dir_path<br />
assignment.try :directory_path<br />
end<br />
<br />
===Remove unused methods===<br />
The following methods have been removed as they were not being used by the application.<br />
<br />
'''def average_score_per_assignment(assignment_id)'''<br />
<br />
def average_score_per_assignment(assignment_id)<br />
return 0 if self.response_maps.size == 0<br />
<br />
sum_of_scores = 0<br />
<br />
self.response_maps.metareview_response_maps.each do |metaresponse_map|<br />
if !metaresponse_map.response.empty? && response_map == assignment_id then<br />
sum_of_scores = sum_of_scores + response_map.response.last.average_score<br />
end<br />
end<br />
<br />
(sum_of_scores / self.response_maps.size).to_i<br />
end<br />
<br />
<br />
'''def quiz_taken_by?(contributor, reviewer)'''<br />
<br />
def quiz_taken_by?(contributor, reviewer)<br />
quiz_id = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
return QuizResponseMap.where(['reviewee_id = ? AND reviewer_id = ? AND reviewed_object_id = ?',<br />
self.id, reviewer.id, quiz_id]).count > 0<br />
end<br />
<br />
<br />
'''def has_quiz?'''<br />
<br />
def has_quiz?<br />
return !QuizQuestionnaire.find_by_instructor_id(self.id).nil?<br />
end<br />
<br />
<br />
'''def reviewees'''<br />
<br />
def reviewees<br />
reviewees = []<br />
rmaps = ResponseMap.all(conditions: ["reviewer_id = #{self.id} && type = 'ReviewResponseMap'"])<br />
rmaps.each { |rm| reviewees.concat(AssignmentTeam.find(rm.reviewee_id).participants) }<br />
<br />
reviewees<br />
end<br />
<br />
<br />
'''def two_node_cycles'''<br />
<br />
def two_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap|<br />
if ap.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap).nil? ? next : s01 = self.reviews_by_reviewer(ap).get_total_score<br />
ap.reviews_by_reviewer(self).nil? ? next : s10 = ap.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap, s10]])<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def three_node_cycles'''<br />
<br />
def three_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap1|<br />
ap1.reviewers.each do |ap2|<br />
if ap2.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap1).nil? ? next : s01 = self.reviews_by_reviewer(ap1).get_total_score<br />
ap1.reviews_by_reviewer(ap2).nil? ? next : s12 = ap1.reviews_by_reviewer(ap2).get_total_score<br />
ap2.reviews_by_reviewer(self).nil? ? next : s20 = ap2.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap1, s12], [ap2, s20]])<br />
end<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def four_node_cycles'''<br />
<br />
def four_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap1|<br />
ap1.reviewers.each do |ap2|<br />
ap2.reviewers.each do |ap3|<br />
if ap3.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap1).nil? ? next : s01 = self.reviews_by_reviewer(ap1).get_total_score<br />
ap1.reviews_by_reviewer(ap2).nil? ? next : s12 = ap1.reviews_by_reviewer(ap2).get_total_score<br />
ap2.reviews_by_reviewer(ap3).nil? ? next : s23 = ap2.reviews_by_reviewer(ap3).get_total_score<br />
ap3.reviews_by_reviewer(self).nil? ? next : s30 = ap3.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap1, s12], [ap2, s23], [ap3, s30]])<br />
end<br />
end<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def cycle_similarity_score(cycle)'''<br />
<br />
def cycle_similarity_score(cycle)<br />
similarity_score = 0.0<br />
count = 0.0<br />
<br />
0 ... cycle.size-1.each do |pivot|<br />
pivot_score = cycle[pivot][1]<br />
similarity_score = similarity_score + (pivot_score - cycle[other][1]).abs<br />
count = count + 1.0<br />
end<br />
<br />
similarity_score = similarity_score / count unless count == 0.0<br />
similarity_score<br />
end<br />
<br />
<br />
'''def cycle_deviation_score(cycle)'''<br />
<br />
def cycle_deviation_score(cycle)<br />
deviation_score = 0.0<br />
count = 0.0<br />
<br />
0 ... cycle.size.each do |member|<br />
participant = AssignmentParticipant.find(cycle[member][0].id)<br />
total_score = participant.get_review_score<br />
deviation_score = deviation_score + (total_score - cycle[member][1]).abs<br />
count = count + 1.0<br />
end<br />
<br />
deviation_score = deviation_score / count unless count == 0.0<br />
deviation_score<br />
end<br />
<br />
<br />
'''def compute_quiz_scores(scores)'''<br />
<br />
def compute_quiz_scores(scores)<br />
total = 0<br />
if scores[:quiz][:scores][:avg]<br />
return scores[:quiz][:scores][:avg] * 100 / 100.to_f<br />
else<br />
return 0<br />
end<br />
return total<br />
end<br />
<br />
<br />
'''def review_response_maps'''<br />
<br />
def review_response_maps<br />
participant = Participant.find(id)<br />
team_id = TeamsUser.team_id(participant.parent_id, participant.user_id)<br />
ReviewResponseMap.where(reviewee_id: team_id, reviewed_object_id: assignment.id)<br />
end<br />
<br />
<br />
'''def members'''<br />
<br />
def members<br />
team.try :participants<br />
end<br />
<br />
<br />
'''def get_hash(time_stamp)'''<br />
<br />
def get_hash(time_stamp)<br />
# first generate a hash from the assignment name itself<br />
hash_data = Digest::SHA1.digest(self.assignment.name.to_s)<br />
<br />
# second generate a hash from the first hash plus the user name and time stamp<br />
sign = hash_data + self.user.name.to_s + time_stamp.strftime("%Y-%m-%d %H:%M:%S")<br />
Digest::SHA1.digest(sign)<br />
end<br />
<br />
===Review methods===<br />
* The bookmark_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''BookmarkRatingQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def bookmark_reviews<br />
BookmarkRatingResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
BookmarkRatingResponseMap.get_assessments_for(participant) # participant.bookmark_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
* The teammate_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''TeammateReviewQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def teammate_reviews<br />
TeammateReviewResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
TeammateReviewResponseMap.get_assessments_for(participant) #participant.teammate_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109635CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T02:34:23Z<p>Cshao: /* Scores method */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
| def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {}<br />
scores[review_sym][:scores][:max] = -999_999_999<br />
scores[review_sym][:scores][:min] = 999_999_999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===set_handle method===<br />
The set_handle method had an unncessary ELSIF statement which was performing the same action '''self.handle = self.user.name'''. This has been clubbed as an OR condition to the IF statement and the first ELSIF statement has been removed.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def set_handle<br />
if self.user.handle == nil or self.user.handle == ""<br />
self.handle = self.user.name<br />
elsif AssignmentParticipant.where(parent_id: self.assignment.id, handle: self.user.handle).length > 0<br />
self.handle = self.user.name<br />
else<br />
self.handle = self.user.handle<br />
end<br />
self.save!<br />
end<br />
<br />
||def set_handle<br />
if self.user.handle == nil or self.user.handle == "" or AssignmentParticipant.where(parent_id: self.assignment.id, handle: self.user.handle).length > 0<br />
self.handle = self.user.name<br />
else<br />
self.handle = self.user.handle<br />
end<br />
self.save!<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===File and directory methods===<br />
The files and directory methods from AssignmentParticipant model have been moved to the '''FileHelper''' module.<br />
The methods '''files''', '''submitted_files''' and '''dir_path''' are appropriate for the '''FileHelper' module and hence been moved there.<br />
The below line was added to the AssignmentParticipant model.<br />
include FileHelper<br />
<br />
The AssignmentParticipant class would look like<br />
class AssignmentParticipant < Participant<br />
require 'wiki_helper'<br />
'''include FileHelper'''<br />
Methods moved to FileHelper:<br />
<br />
* submitted_files<br />
<br />
def submitted_files<br />
files(self.path) if self.directory_num<br />
end<br />
<br />
* files(directory)<br />
<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = Array.new<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each{|f| files << f}<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
* submitted_files()<br />
<br />
def submitted_files()<br />
files = Array.new<br />
if(self.directory_num)<br />
files = files(self.path)<br />
end<br />
return files<br />
end<br />
<br />
* dir_path<br />
<br />
def dir_path<br />
assignment.try :directory_path<br />
end<br />
<br />
===Remove unused methods===<br />
The following methods have been removed as they were not being used by the application.<br />
<br />
'''def average_score_per_assignment(assignment_id)'''<br />
<br />
def average_score_per_assignment(assignment_id)<br />
return 0 if self.response_maps.size == 0<br />
<br />
sum_of_scores = 0<br />
<br />
self.response_maps.metareview_response_maps.each do |metaresponse_map|<br />
if !metaresponse_map.response.empty? && response_map == assignment_id then<br />
sum_of_scores = sum_of_scores + response_map.response.last.average_score<br />
end<br />
end<br />
<br />
(sum_of_scores / self.response_maps.size).to_i<br />
end<br />
<br />
<br />
'''def quiz_taken_by?(contributor, reviewer)'''<br />
<br />
def quiz_taken_by?(contributor, reviewer)<br />
quiz_id = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
return QuizResponseMap.where(['reviewee_id = ? AND reviewer_id = ? AND reviewed_object_id = ?',<br />
self.id, reviewer.id, quiz_id]).count > 0<br />
end<br />
<br />
<br />
'''def has_quiz?'''<br />
<br />
def has_quiz?<br />
return !QuizQuestionnaire.find_by_instructor_id(self.id).nil?<br />
end<br />
<br />
<br />
'''def reviewees'''<br />
<br />
def reviewees<br />
reviewees = []<br />
rmaps = ResponseMap.all(conditions: ["reviewer_id = #{self.id} && type = 'ReviewResponseMap'"])<br />
rmaps.each { |rm| reviewees.concat(AssignmentTeam.find(rm.reviewee_id).participants) }<br />
<br />
reviewees<br />
end<br />
<br />
<br />
'''def two_node_cycles'''<br />
<br />
def two_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap|<br />
if ap.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap).nil? ? next : s01 = self.reviews_by_reviewer(ap).get_total_score<br />
ap.reviews_by_reviewer(self).nil? ? next : s10 = ap.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap, s10]])<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def three_node_cycles'''<br />
<br />
def three_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap1|<br />
ap1.reviewers.each do |ap2|<br />
if ap2.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap1).nil? ? next : s01 = self.reviews_by_reviewer(ap1).get_total_score<br />
ap1.reviews_by_reviewer(ap2).nil? ? next : s12 = ap1.reviews_by_reviewer(ap2).get_total_score<br />
ap2.reviews_by_reviewer(self).nil? ? next : s20 = ap2.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap1, s12], [ap2, s20]])<br />
end<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def four_node_cycles'''<br />
<br />
def four_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap1|<br />
ap1.reviewers.each do |ap2|<br />
ap2.reviewers.each do |ap3|<br />
if ap3.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap1).nil? ? next : s01 = self.reviews_by_reviewer(ap1).get_total_score<br />
ap1.reviews_by_reviewer(ap2).nil? ? next : s12 = ap1.reviews_by_reviewer(ap2).get_total_score<br />
ap2.reviews_by_reviewer(ap3).nil? ? next : s23 = ap2.reviews_by_reviewer(ap3).get_total_score<br />
ap3.reviews_by_reviewer(self).nil? ? next : s30 = ap3.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap1, s12], [ap2, s23], [ap3, s30]])<br />
end<br />
end<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def cycle_similarity_score(cycle)'''<br />
<br />
def cycle_similarity_score(cycle)<br />
similarity_score = 0.0<br />
count = 0.0<br />
<br />
0 ... cycle.size-1.each do |pivot|<br />
pivot_score = cycle[pivot][1]<br />
similarity_score = similarity_score + (pivot_score - cycle[other][1]).abs<br />
count = count + 1.0<br />
end<br />
<br />
similarity_score = similarity_score / count unless count == 0.0<br />
similarity_score<br />
end<br />
<br />
<br />
'''def cycle_deviation_score(cycle)'''<br />
<br />
def cycle_deviation_score(cycle)<br />
deviation_score = 0.0<br />
count = 0.0<br />
<br />
0 ... cycle.size.each do |member|<br />
participant = AssignmentParticipant.find(cycle[member][0].id)<br />
total_score = participant.get_review_score<br />
deviation_score = deviation_score + (total_score - cycle[member][1]).abs<br />
count = count + 1.0<br />
end<br />
<br />
deviation_score = deviation_score / count unless count == 0.0<br />
deviation_score<br />
end<br />
<br />
<br />
'''def compute_quiz_scores(scores)'''<br />
<br />
def compute_quiz_scores(scores)<br />
total = 0<br />
if scores[:quiz][:scores][:avg]<br />
return scores[:quiz][:scores][:avg] * 100 / 100.to_f<br />
else<br />
return 0<br />
end<br />
return total<br />
end<br />
<br />
<br />
'''def review_response_maps'''<br />
<br />
def review_response_maps<br />
participant = Participant.find(id)<br />
team_id = TeamsUser.team_id(participant.parent_id, participant.user_id)<br />
ReviewResponseMap.where(reviewee_id: team_id, reviewed_object_id: assignment.id)<br />
end<br />
<br />
<br />
'''def members'''<br />
<br />
def members<br />
team.try :participants<br />
end<br />
<br />
<br />
'''def get_hash(time_stamp)'''<br />
<br />
def get_hash(time_stamp)<br />
# first generate a hash from the assignment name itself<br />
hash_data = Digest::SHA1.digest(self.assignment.name.to_s)<br />
<br />
# second generate a hash from the first hash plus the user name and time stamp<br />
sign = hash_data + self.user.name.to_s + time_stamp.strftime("%Y-%m-%d %H:%M:%S")<br />
Digest::SHA1.digest(sign)<br />
end<br />
<br />
===Review methods===<br />
* The bookmark_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''BookmarkRatingQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def bookmark_reviews<br />
BookmarkRatingResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
BookmarkRatingResponseMap.get_assessments_for(participant) # participant.bookmark_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
* The teammate_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''TeammateReviewQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def teammate_reviews<br />
TeammateReviewResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
TeammateReviewResponseMap.get_assessments_for(participant) #participant.teammate_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109633CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T02:32:22Z<p>Cshao: /* Scores method */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by_assignment_id_and_questionnaire_id(self.assignment.id, questionnaire.id).used_in_round<br />
#create symbol for "varying rubrics" feature -Yang<br />
if(round!=nil)<br />
questionnaire_symbol = (questionnaire.symbol.to_s+round.to_s).to_sym<br />
else<br />
questionnaire_symbol = questionnaire.symbol<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
if round==nil<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_for(self)<br />
else<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_round_for(self,round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
#merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = Hash.new<br />
scores[review_sym][:assessments] = Array.new<br />
scores[review_sym][:scores] = Hash.new<br />
scores[review_sym][:scores][:max] = -999999999<br />
scores[review_sym][:scores][:min] = 999999999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.get_review_rounds<br />
round_sym = ("review"+i.to_s).to_sym<br />
if scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].length==0<br />
next<br />
end<br />
length_of_assessments=scores[round_sym][:assessments].length.to_f<br />
<br />
scores[review_sym][:assessments]+=scores[round_sym][:assessments]<br />
<br />
if(scores[round_sym][:scores][:max]!=nil && scores[review_sym][:scores][:max]<scores[round_sym][:scores][:max])<br />
scores[review_sym][:scores][:max]= scores[round_sym][:scores][:max]<br />
end<br />
if(scores[round_sym][:scores][:min]!= nil && scores[review_sym][:scores][:min]>scores[round_sym][:scores][:min])<br />
scores[review_sym][:scores][:min]= scores[round_sym][:scores][:min]<br />
end<br />
if(scores[round_sym][:scores][:avg]!=nil)<br />
total_score += scores[round_sym][:scores][:avg]*length_of_assessments<br />
end<br />
end<br />
<br />
if scores[review_sym][:scores][:max] == -999999999 && scores[review_sym][:scores][:min] == 999999999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
<br />
scores[review_sym][:scores][:avg] = total_score/scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
if !topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
quiz_responses = Array.new<br />
quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
quiz_response_mappings.each do |qmapping|<br />
if (qmapping.response)<br />
quiz_responses << qmapping.response<br />
end<br />
end<br />
#scores[:quiz] = Hash.new<br />
#scores[:quiz][:assessments] = quiz_responses<br />
#scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
#scores[:total_score] += compute_quiz_scores(scores)<br />
<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
total_score = scores[:total_score]<br />
if total_score > 100<br />
total_score = 100<br />
end<br />
scores[:total_score] = total_score<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
assignment_questionnaires(questions, scores)<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
# merge scores[review#] (for each round) to score[review] -Yang<br />
merge_scores(scores) if self.assignment.varying_rubrics_by_round?<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
topic_total_scores(scores) if self.assignment.is_microtask?<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
# quiz_responses = []<br />
# quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
# quiz_response_mappings.each do |qmapping|<br />
# quiz_responses << qmapping.response if qmapping.response<br />
# end<br />
# scores[:quiz] = Hash.new<br />
# scores[:quiz][:assessments] = quiz_responses<br />
# scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
# scores[:total_score] += compute_quiz_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
caculate_scores(scores)<br />
end<br />
<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by(assignment_id: self.assignment.id, questionnaire_id: questionnaire.id).used_in_round<br />
# create symbol for "varying rubrics" feature -Yang<br />
questionnaire_symbol = if round.nil?<br />
questionnaire.symbol<br />
else<br />
(questionnaire.symbol.to_s + round.to_s).to_sym<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
scores[questionnaire_symbol][:assessments] = if round.nil?<br />
questionnaire.get_assessments_for(self)<br />
else<br />
questionnaire.get_assessments_round_for(self, round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
review_sym = "review".to_sym<br />
scores[review_sym] = {}<br />
scores[review_sym][:assessments] = []<br />
scores[review_sym][:scores] = {max: -999_999_999, min: 999_999_999, avg: 0}<br />
total_score = 0<br />
for i in 1..self.assignment.num_review_rounds<br />
round_sym = ("review" + i.to_s).to_sym<br />
if scores[round_sym].nil? || scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].empty?<br />
next<br />
end<br />
length_of_assessments = scores[round_sym][:assessments].length.to_f<br />
scores[review_sym][:assessments] += scores[round_sym][:assessments]<br />
if !scores[round_sym][:scores][:max].nil? && scores[review_sym][:scores][:max] < scores[round_sym][:scores][:max]<br />
scores[review_sym][:scores][:max] = scores[round_sym][:scores][:max]<br />
end<br />
if !scores[round_sym][:scores][:min].nil? && scores[review_sym][:scores][:min] > scores[round_sym][:scores][:min]<br />
scores[review_sym][:scores][:min] = scores[round_sym][:scores][:min]<br />
end<br />
unless scores[round_sym][:scores][:avg].nil?<br />
total_score += scores[round_sym][:scores][:avg] * length_of_assessments<br />
end<br />
end<br />
if scores[review_sym][:scores][:max] == -999_999_999 && scores[review_sym][:scores][:min] == 999_999_999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
scores[review_sym][:scores][:avg] = total_score / scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
* topic_total_scores(scores) method<br />
<br />
def topic_total_scores(scores)<br />
topic = SignUpTopic.find_by(assignment_id: self.assignment.id)<br />
unless topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def caculate_scores(scores)<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
scores[:total_score] = 100 if scores[:total_score] > 100<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===set_handle method===<br />
The set_handle method had an unncessary ELSIF statement which was performing the same action '''self.handle = self.user.name'''. This has been clubbed as an OR condition to the IF statement and the first ELSIF statement has been removed.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def set_handle<br />
if self.user.handle == nil or self.user.handle == ""<br />
self.handle = self.user.name<br />
elsif AssignmentParticipant.where(parent_id: self.assignment.id, handle: self.user.handle).length > 0<br />
self.handle = self.user.name<br />
else<br />
self.handle = self.user.handle<br />
end<br />
self.save!<br />
end<br />
<br />
||def set_handle<br />
if self.user.handle == nil or self.user.handle == "" or AssignmentParticipant.where(parent_id: self.assignment.id, handle: self.user.handle).length > 0<br />
self.handle = self.user.name<br />
else<br />
self.handle = self.user.handle<br />
end<br />
self.save!<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===File and directory methods===<br />
The files and directory methods from AssignmentParticipant model have been moved to the '''FileHelper''' module.<br />
The methods '''files''', '''submitted_files''' and '''dir_path''' are appropriate for the '''FileHelper' module and hence been moved there.<br />
The below line was added to the AssignmentParticipant model.<br />
include FileHelper<br />
<br />
The AssignmentParticipant class would look like<br />
class AssignmentParticipant < Participant<br />
require 'wiki_helper'<br />
'''include FileHelper'''<br />
Methods moved to FileHelper:<br />
<br />
* submitted_files<br />
<br />
def submitted_files<br />
files(self.path) if self.directory_num<br />
end<br />
<br />
* files(directory)<br />
<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = Array.new<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each{|f| files << f}<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
* submitted_files()<br />
<br />
def submitted_files()<br />
files = Array.new<br />
if(self.directory_num)<br />
files = files(self.path)<br />
end<br />
return files<br />
end<br />
<br />
* dir_path<br />
<br />
def dir_path<br />
assignment.try :directory_path<br />
end<br />
<br />
===Remove unused methods===<br />
The following methods have been removed as they were not being used by the application.<br />
<br />
'''def average_score_per_assignment(assignment_id)'''<br />
<br />
def average_score_per_assignment(assignment_id)<br />
return 0 if self.response_maps.size == 0<br />
<br />
sum_of_scores = 0<br />
<br />
self.response_maps.metareview_response_maps.each do |metaresponse_map|<br />
if !metaresponse_map.response.empty? && response_map == assignment_id then<br />
sum_of_scores = sum_of_scores + response_map.response.last.average_score<br />
end<br />
end<br />
<br />
(sum_of_scores / self.response_maps.size).to_i<br />
end<br />
<br />
<br />
'''def quiz_taken_by?(contributor, reviewer)'''<br />
<br />
def quiz_taken_by?(contributor, reviewer)<br />
quiz_id = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
return QuizResponseMap.where(['reviewee_id = ? AND reviewer_id = ? AND reviewed_object_id = ?',<br />
self.id, reviewer.id, quiz_id]).count > 0<br />
end<br />
<br />
<br />
'''def has_quiz?'''<br />
<br />
def has_quiz?<br />
return !QuizQuestionnaire.find_by_instructor_id(self.id).nil?<br />
end<br />
<br />
<br />
'''def reviewees'''<br />
<br />
def reviewees<br />
reviewees = []<br />
rmaps = ResponseMap.all(conditions: ["reviewer_id = #{self.id} && type = 'ReviewResponseMap'"])<br />
rmaps.each { |rm| reviewees.concat(AssignmentTeam.find(rm.reviewee_id).participants) }<br />
<br />
reviewees<br />
end<br />
<br />
<br />
'''def two_node_cycles'''<br />
<br />
def two_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap|<br />
if ap.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap).nil? ? next : s01 = self.reviews_by_reviewer(ap).get_total_score<br />
ap.reviews_by_reviewer(self).nil? ? next : s10 = ap.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap, s10]])<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def three_node_cycles'''<br />
<br />
def three_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap1|<br />
ap1.reviewers.each do |ap2|<br />
if ap2.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap1).nil? ? next : s01 = self.reviews_by_reviewer(ap1).get_total_score<br />
ap1.reviews_by_reviewer(ap2).nil? ? next : s12 = ap1.reviews_by_reviewer(ap2).get_total_score<br />
ap2.reviews_by_reviewer(self).nil? ? next : s20 = ap2.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap1, s12], [ap2, s20]])<br />
end<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def four_node_cycles'''<br />
<br />
def four_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap1|<br />
ap1.reviewers.each do |ap2|<br />
ap2.reviewers.each do |ap3|<br />
if ap3.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap1).nil? ? next : s01 = self.reviews_by_reviewer(ap1).get_total_score<br />
ap1.reviews_by_reviewer(ap2).nil? ? next : s12 = ap1.reviews_by_reviewer(ap2).get_total_score<br />
ap2.reviews_by_reviewer(ap3).nil? ? next : s23 = ap2.reviews_by_reviewer(ap3).get_total_score<br />
ap3.reviews_by_reviewer(self).nil? ? next : s30 = ap3.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap1, s12], [ap2, s23], [ap3, s30]])<br />
end<br />
end<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def cycle_similarity_score(cycle)'''<br />
<br />
def cycle_similarity_score(cycle)<br />
similarity_score = 0.0<br />
count = 0.0<br />
<br />
0 ... cycle.size-1.each do |pivot|<br />
pivot_score = cycle[pivot][1]<br />
similarity_score = similarity_score + (pivot_score - cycle[other][1]).abs<br />
count = count + 1.0<br />
end<br />
<br />
similarity_score = similarity_score / count unless count == 0.0<br />
similarity_score<br />
end<br />
<br />
<br />
'''def cycle_deviation_score(cycle)'''<br />
<br />
def cycle_deviation_score(cycle)<br />
deviation_score = 0.0<br />
count = 0.0<br />
<br />
0 ... cycle.size.each do |member|<br />
participant = AssignmentParticipant.find(cycle[member][0].id)<br />
total_score = participant.get_review_score<br />
deviation_score = deviation_score + (total_score - cycle[member][1]).abs<br />
count = count + 1.0<br />
end<br />
<br />
deviation_score = deviation_score / count unless count == 0.0<br />
deviation_score<br />
end<br />
<br />
<br />
'''def compute_quiz_scores(scores)'''<br />
<br />
def compute_quiz_scores(scores)<br />
total = 0<br />
if scores[:quiz][:scores][:avg]<br />
return scores[:quiz][:scores][:avg] * 100 / 100.to_f<br />
else<br />
return 0<br />
end<br />
return total<br />
end<br />
<br />
<br />
'''def review_response_maps'''<br />
<br />
def review_response_maps<br />
participant = Participant.find(id)<br />
team_id = TeamsUser.team_id(participant.parent_id, participant.user_id)<br />
ReviewResponseMap.where(reviewee_id: team_id, reviewed_object_id: assignment.id)<br />
end<br />
<br />
<br />
'''def members'''<br />
<br />
def members<br />
team.try :participants<br />
end<br />
<br />
<br />
'''def get_hash(time_stamp)'''<br />
<br />
def get_hash(time_stamp)<br />
# first generate a hash from the assignment name itself<br />
hash_data = Digest::SHA1.digest(self.assignment.name.to_s)<br />
<br />
# second generate a hash from the first hash plus the user name and time stamp<br />
sign = hash_data + self.user.name.to_s + time_stamp.strftime("%Y-%m-%d %H:%M:%S")<br />
Digest::SHA1.digest(sign)<br />
end<br />
<br />
===Review methods===<br />
* The bookmark_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''BookmarkRatingQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def bookmark_reviews<br />
BookmarkRatingResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
BookmarkRatingResponseMap.get_assessments_for(participant) # participant.bookmark_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
* The teammate_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''TeammateReviewQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def teammate_reviews<br />
TeammateReviewResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
TeammateReviewResponseMap.get_assessments_for(participant) #participant.teammate_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109626CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-27T02:23:58Z<p>Cshao: /* Scores method */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''topic_total_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by_assignment_id_and_questionnaire_id(self.assignment.id, questionnaire.id).used_in_round<br />
#create symbol for "varying rubrics" feature -Yang<br />
if(round!=nil)<br />
questionnaire_symbol = (questionnaire.symbol.to_s+round.to_s).to_sym<br />
else<br />
questionnaire_symbol = questionnaire.symbol<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
if round==nil<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_for(self)<br />
else<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_round_for(self,round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
#merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = Hash.new<br />
scores[review_sym][:assessments] = Array.new<br />
scores[review_sym][:scores] = Hash.new<br />
scores[review_sym][:scores][:max] = -999999999<br />
scores[review_sym][:scores][:min] = 999999999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.get_review_rounds<br />
round_sym = ("review"+i.to_s).to_sym<br />
if scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].length==0<br />
next<br />
end<br />
length_of_assessments=scores[round_sym][:assessments].length.to_f<br />
<br />
scores[review_sym][:assessments]+=scores[round_sym][:assessments]<br />
<br />
if(scores[round_sym][:scores][:max]!=nil && scores[review_sym][:scores][:max]<scores[round_sym][:scores][:max])<br />
scores[review_sym][:scores][:max]= scores[round_sym][:scores][:max]<br />
end<br />
if(scores[round_sym][:scores][:min]!= nil && scores[review_sym][:scores][:min]>scores[round_sym][:scores][:min])<br />
scores[review_sym][:scores][:min]= scores[round_sym][:scores][:min]<br />
end<br />
if(scores[round_sym][:scores][:avg]!=nil)<br />
total_score += scores[round_sym][:scores][:avg]*length_of_assessments<br />
end<br />
end<br />
<br />
if scores[review_sym][:scores][:max] == -999999999 && scores[review_sym][:scores][:min] == 999999999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
<br />
scores[review_sym][:scores][:avg] = total_score/scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
if !topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
quiz_responses = Array.new<br />
quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
quiz_response_mappings.each do |qmapping|<br />
if (qmapping.response)<br />
quiz_responses << qmapping.response<br />
end<br />
end<br />
#scores[:quiz] = Hash.new<br />
#scores[:quiz][:assessments] = quiz_responses<br />
#scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
#scores[:total_score] += compute_quiz_scores(scores)<br />
<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
total_score = scores[:total_score]<br />
if total_score > 100<br />
total_score = 100<br />
end<br />
scores[:total_score] = total_score<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
<br />
assignment_questionnaires(questions, scores)<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
merge_scores(scores)<br />
<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
if !topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
quiz_responses = Array.new<br />
quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
quiz_response_mappings.each do |qmapping|<br />
if (qmapping.response)<br />
quiz_responses << qmapping.response<br />
end<br />
end<br />
#scores[:quiz] = Hash.new<br />
#scores[:quiz][:assessments] = quiz_responses<br />
#scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
#scores[:total_score] += compute_quiz_scores(scores)<br />
<br />
calculate_scores(scores)<br />
end<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by_assignment_id_and_questionnaire_id(self.assignment.id, questionnaire.id).used_in_round<br />
#create symbol for "varying rubrics" feature -Yang<br />
if(round!=nil)<br />
questionnaire_symbol = (questionnaire.symbol.to_s+round.to_s).to_sym<br />
else<br />
questionnaire_symbol = questionnaire.symbol<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
if round==nil<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_for(self)<br />
else<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_round_for(self,round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
#merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = Hash.new<br />
scores[review_sym][:assessments] = Array.new<br />
scores[review_sym][:scores] = Hash.new<br />
scores[review_sym][:scores][:max] = -999999999<br />
scores[review_sym][:scores][:min] = 999999999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.get_review_rounds<br />
round_sym = ("review"+i.to_s).to_sym<br />
if scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].length==0<br />
next<br />
end<br />
length_of_assessments=scores[round_sym][:assessments].length.to_f<br />
<br />
scores[review_sym][:assessments]+=scores[round_sym][:assessments]<br />
<br />
if(scores[round_sym][:scores][:max]!=nil && scores[review_sym][:scores][:max]<scores[round_sym][:scores][:max])<br />
scores[review_sym][:scores][:max]= scores[round_sym][:scores][:max]<br />
end<br />
if(scores[round_sym][:scores][:min]!= nil && scores[review_sym][:scores][:min]>scores[round_sym][:scores][:min])<br />
scores[review_sym][:scores][:min]= scores[round_sym][:scores][:min]<br />
end<br />
if(scores[round_sym][:scores][:avg]!=nil)<br />
total_score += scores[round_sym][:scores][:avg]*length_of_assessments<br />
end<br />
end<br />
<br />
if scores[review_sym][:scores][:max] == -999999999 && scores[review_sym][:scores][:min] == 999999999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
<br />
scores[review_sym][:scores][:avg] = total_score/scores[review_sym][:assessments].length.to_f<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def calculate_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
total_score = scores[:total_score]<br />
if total_score > 100<br />
total_score = 100<br />
end<br />
scores[:total_score] = total_score<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===set_handle method===<br />
The set_handle method had an unncessary ELSIF statement which was performing the same action '''self.handle = self.user.name'''. This has been clubbed as an OR condition to the IF statement and the first ELSIF statement has been removed.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def set_handle<br />
if self.user.handle == nil or self.user.handle == ""<br />
self.handle = self.user.name<br />
elsif AssignmentParticipant.where(parent_id: self.assignment.id, handle: self.user.handle).length > 0<br />
self.handle = self.user.name<br />
else<br />
self.handle = self.user.handle<br />
end<br />
self.save!<br />
end<br />
<br />
||def set_handle<br />
if self.user.handle == nil or self.user.handle == "" or AssignmentParticipant.where(parent_id: self.assignment.id, handle: self.user.handle).length > 0<br />
self.handle = self.user.name<br />
else<br />
self.handle = self.user.handle<br />
end<br />
self.save!<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===File and directory methods===<br />
The files and directory methods from AssignmentParticipant model have been moved to the '''FileHelper''' module.<br />
The methods '''files''', '''submitted_files''' and '''dir_path''' are appropriate for the '''FileHelper' module and hence been moved there.<br />
The below line was added to the AssignmentParticipant model.<br />
include FileHelper<br />
<br />
The AssignmentParticipant class would look like<br />
class AssignmentParticipant < Participant<br />
require 'wiki_helper'<br />
'''include FileHelper'''<br />
Methods moved to FileHelper:<br />
<br />
* submitted_files<br />
<br />
def submitted_files<br />
files(self.path) if self.directory_num<br />
end<br />
<br />
* files(directory)<br />
<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = Array.new<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each{|f| files << f}<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
* submitted_files()<br />
<br />
def submitted_files()<br />
files = Array.new<br />
if(self.directory_num)<br />
files = files(self.path)<br />
end<br />
return files<br />
end<br />
<br />
* dir_path<br />
<br />
def dir_path<br />
assignment.try :directory_path<br />
end<br />
<br />
===Remove unused methods===<br />
The following methods have been removed as they were not being used by the application.<br />
<br />
'''def average_score_per_assignment(assignment_id)'''<br />
<br />
def average_score_per_assignment(assignment_id)<br />
return 0 if self.response_maps.size == 0<br />
<br />
sum_of_scores = 0<br />
<br />
self.response_maps.metareview_response_maps.each do |metaresponse_map|<br />
if !metaresponse_map.response.empty? && response_map == assignment_id then<br />
sum_of_scores = sum_of_scores + response_map.response.last.average_score<br />
end<br />
end<br />
<br />
(sum_of_scores / self.response_maps.size).to_i<br />
end<br />
<br />
<br />
'''def quiz_taken_by?(contributor, reviewer)'''<br />
<br />
def quiz_taken_by?(contributor, reviewer)<br />
quiz_id = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
return QuizResponseMap.where(['reviewee_id = ? AND reviewer_id = ? AND reviewed_object_id = ?',<br />
self.id, reviewer.id, quiz_id]).count > 0<br />
end<br />
<br />
<br />
'''def has_quiz?'''<br />
<br />
def has_quiz?<br />
return !QuizQuestionnaire.find_by_instructor_id(self.id).nil?<br />
end<br />
<br />
<br />
'''def reviewees'''<br />
<br />
def reviewees<br />
reviewees = []<br />
rmaps = ResponseMap.all(conditions: ["reviewer_id = #{self.id} && type = 'ReviewResponseMap'"])<br />
rmaps.each { |rm| reviewees.concat(AssignmentTeam.find(rm.reviewee_id).participants) }<br />
<br />
reviewees<br />
end<br />
<br />
<br />
'''def two_node_cycles'''<br />
<br />
def two_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap|<br />
if ap.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap).nil? ? next : s01 = self.reviews_by_reviewer(ap).get_total_score<br />
ap.reviews_by_reviewer(self).nil? ? next : s10 = ap.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap, s10]])<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def three_node_cycles'''<br />
<br />
def three_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap1|<br />
ap1.reviewers.each do |ap2|<br />
if ap2.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap1).nil? ? next : s01 = self.reviews_by_reviewer(ap1).get_total_score<br />
ap1.reviews_by_reviewer(ap2).nil? ? next : s12 = ap1.reviews_by_reviewer(ap2).get_total_score<br />
ap2.reviews_by_reviewer(self).nil? ? next : s20 = ap2.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap1, s12], [ap2, s20]])<br />
end<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def four_node_cycles'''<br />
<br />
def four_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap1|<br />
ap1.reviewers.each do |ap2|<br />
ap2.reviewers.each do |ap3|<br />
if ap3.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap1).nil? ? next : s01 = self.reviews_by_reviewer(ap1).get_total_score<br />
ap1.reviews_by_reviewer(ap2).nil? ? next : s12 = ap1.reviews_by_reviewer(ap2).get_total_score<br />
ap2.reviews_by_reviewer(ap3).nil? ? next : s23 = ap2.reviews_by_reviewer(ap3).get_total_score<br />
ap3.reviews_by_reviewer(self).nil? ? next : s30 = ap3.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap1, s12], [ap2, s23], [ap3, s30]])<br />
end<br />
end<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def cycle_similarity_score(cycle)'''<br />
<br />
def cycle_similarity_score(cycle)<br />
similarity_score = 0.0<br />
count = 0.0<br />
<br />
0 ... cycle.size-1.each do |pivot|<br />
pivot_score = cycle[pivot][1]<br />
similarity_score = similarity_score + (pivot_score - cycle[other][1]).abs<br />
count = count + 1.0<br />
end<br />
<br />
similarity_score = similarity_score / count unless count == 0.0<br />
similarity_score<br />
end<br />
<br />
<br />
'''def cycle_deviation_score(cycle)'''<br />
<br />
def cycle_deviation_score(cycle)<br />
deviation_score = 0.0<br />
count = 0.0<br />
<br />
0 ... cycle.size.each do |member|<br />
participant = AssignmentParticipant.find(cycle[member][0].id)<br />
total_score = participant.get_review_score<br />
deviation_score = deviation_score + (total_score - cycle[member][1]).abs<br />
count = count + 1.0<br />
end<br />
<br />
deviation_score = deviation_score / count unless count == 0.0<br />
deviation_score<br />
end<br />
<br />
<br />
'''def compute_quiz_scores(scores)'''<br />
<br />
def compute_quiz_scores(scores)<br />
total = 0<br />
if scores[:quiz][:scores][:avg]<br />
return scores[:quiz][:scores][:avg] * 100 / 100.to_f<br />
else<br />
return 0<br />
end<br />
return total<br />
end<br />
<br />
<br />
'''def review_response_maps'''<br />
<br />
def review_response_maps<br />
participant = Participant.find(id)<br />
team_id = TeamsUser.team_id(participant.parent_id, participant.user_id)<br />
ReviewResponseMap.where(reviewee_id: team_id, reviewed_object_id: assignment.id)<br />
end<br />
<br />
<br />
'''def members'''<br />
<br />
def members<br />
team.try :participants<br />
end<br />
<br />
<br />
'''def get_hash(time_stamp)'''<br />
<br />
def get_hash(time_stamp)<br />
# first generate a hash from the assignment name itself<br />
hash_data = Digest::SHA1.digest(self.assignment.name.to_s)<br />
<br />
# second generate a hash from the first hash plus the user name and time stamp<br />
sign = hash_data + self.user.name.to_s + time_stamp.strftime("%Y-%m-%d %H:%M:%S")<br />
Digest::SHA1.digest(sign)<br />
end<br />
<br />
===Review methods===<br />
* The bookmark_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''BookmarkRatingQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def bookmark_reviews<br />
BookmarkRatingResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
BookmarkRatingResponseMap.get_assessments_for(participant) # participant.bookmark_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
* The teammate_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''TeammateReviewQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def teammate_reviews<br />
TeammateReviewResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
TeammateReviewResponseMap.get_assessments_for(participant) #participant.teammate_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109412CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-26T15:50:45Z<p>Cshao: /* Test First Development */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test Cases==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by_assignment_id_and_questionnaire_id(self.assignment.id, questionnaire.id).used_in_round<br />
#create symbol for "varying rubrics" feature -Yang<br />
if(round!=nil)<br />
questionnaire_symbol = (questionnaire.symbol.to_s+round.to_s).to_sym<br />
else<br />
questionnaire_symbol = questionnaire.symbol<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
if round==nil<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_for(self)<br />
else<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_round_for(self,round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
#merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = Hash.new<br />
scores[review_sym][:assessments] = Array.new<br />
scores[review_sym][:scores] = Hash.new<br />
scores[review_sym][:scores][:max] = -999999999<br />
scores[review_sym][:scores][:min] = 999999999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.get_review_rounds<br />
round_sym = ("review"+i.to_s).to_sym<br />
if scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].length==0<br />
next<br />
end<br />
length_of_assessments=scores[round_sym][:assessments].length.to_f<br />
<br />
scores[review_sym][:assessments]+=scores[round_sym][:assessments]<br />
<br />
if(scores[round_sym][:scores][:max]!=nil && scores[review_sym][:scores][:max]<scores[round_sym][:scores][:max])<br />
scores[review_sym][:scores][:max]= scores[round_sym][:scores][:max]<br />
end<br />
if(scores[round_sym][:scores][:min]!= nil && scores[review_sym][:scores][:min]>scores[round_sym][:scores][:min])<br />
scores[review_sym][:scores][:min]= scores[round_sym][:scores][:min]<br />
end<br />
if(scores[round_sym][:scores][:avg]!=nil)<br />
total_score += scores[round_sym][:scores][:avg]*length_of_assessments<br />
end<br />
end<br />
<br />
if scores[review_sym][:scores][:max] == -999999999 && scores[review_sym][:scores][:min] == 999999999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
<br />
scores[review_sym][:scores][:avg] = total_score/scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
if !topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
quiz_responses = Array.new<br />
quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
quiz_response_mappings.each do |qmapping|<br />
if (qmapping.response)<br />
quiz_responses << qmapping.response<br />
end<br />
end<br />
#scores[:quiz] = Hash.new<br />
#scores[:quiz][:assessments] = quiz_responses<br />
#scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
#scores[:total_score] += compute_quiz_scores(scores)<br />
<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
total_score = scores[:total_score]<br />
if total_score > 100<br />
total_score = 100<br />
end<br />
scores[:total_score] = total_score<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
<br />
assignment_questionnaires(questions, scores)<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
merge_scores(scores)<br />
<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
if !topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
quiz_responses = Array.new<br />
quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
quiz_response_mappings.each do |qmapping|<br />
if (qmapping.response)<br />
quiz_responses << qmapping.response<br />
end<br />
end<br />
#scores[:quiz] = Hash.new<br />
#scores[:quiz][:assessments] = quiz_responses<br />
#scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
#scores[:total_score] += compute_quiz_scores(scores)<br />
<br />
calculate_scores(scores)<br />
end<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by_assignment_id_and_questionnaire_id(self.assignment.id, questionnaire.id).used_in_round<br />
#create symbol for "varying rubrics" feature -Yang<br />
if(round!=nil)<br />
questionnaire_symbol = (questionnaire.symbol.to_s+round.to_s).to_sym<br />
else<br />
questionnaire_symbol = questionnaire.symbol<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
if round==nil<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_for(self)<br />
else<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_round_for(self,round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
#merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = Hash.new<br />
scores[review_sym][:assessments] = Array.new<br />
scores[review_sym][:scores] = Hash.new<br />
scores[review_sym][:scores][:max] = -999999999<br />
scores[review_sym][:scores][:min] = 999999999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.get_review_rounds<br />
round_sym = ("review"+i.to_s).to_sym<br />
if scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].length==0<br />
next<br />
end<br />
length_of_assessments=scores[round_sym][:assessments].length.to_f<br />
<br />
scores[review_sym][:assessments]+=scores[round_sym][:assessments]<br />
<br />
if(scores[round_sym][:scores][:max]!=nil && scores[review_sym][:scores][:max]<scores[round_sym][:scores][:max])<br />
scores[review_sym][:scores][:max]= scores[round_sym][:scores][:max]<br />
end<br />
if(scores[round_sym][:scores][:min]!= nil && scores[review_sym][:scores][:min]>scores[round_sym][:scores][:min])<br />
scores[review_sym][:scores][:min]= scores[round_sym][:scores][:min]<br />
end<br />
if(scores[round_sym][:scores][:avg]!=nil)<br />
total_score += scores[round_sym][:scores][:avg]*length_of_assessments<br />
end<br />
end<br />
<br />
if scores[review_sym][:scores][:max] == -999999999 && scores[review_sym][:scores][:min] == 999999999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
<br />
scores[review_sym][:scores][:avg] = total_score/scores[review_sym][:assessments].length.to_f<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def calculate_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
total_score = scores[:total_score]<br />
if total_score > 100<br />
total_score = 100<br />
end<br />
scores[:total_score] = total_score<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===set_handle method===<br />
The set_handle method had an unncessary ELSIF statement which was performing the same action '''self.handle = self.user.name'''. This has been clubbed as an OR condition to the IF statement and the first ELSIF statement has been removed.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def set_handle<br />
if self.user.handle == nil or self.user.handle == ""<br />
self.handle = self.user.name<br />
elsif AssignmentParticipant.where(parent_id: self.assignment.id, handle: self.user.handle).length > 0<br />
self.handle = self.user.name<br />
else<br />
self.handle = self.user.handle<br />
end<br />
self.save!<br />
end<br />
<br />
||def set_handle<br />
if self.user.handle == nil or self.user.handle == "" or AssignmentParticipant.where(parent_id: self.assignment.id, handle: self.user.handle).length > 0<br />
self.handle = self.user.name<br />
else<br />
self.handle = self.user.handle<br />
end<br />
self.save!<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===File and directory methods===<br />
The files and directory methods from AssignmentParticipant model have been moved to the '''FileHelper''' module.<br />
The methods '''files''', '''submitted_files''' and '''dir_path''' are appropriate for the '''FileHelper' module and hence been moved there.<br />
The below line was added to the AssignmentParticipant model.<br />
include FileHelper<br />
<br />
The AssignmentParticipant class would look like<br />
class AssignmentParticipant < Participant<br />
require 'wiki_helper'<br />
'''include FileHelper'''<br />
Methods moved to FileHelper:<br />
<br />
* submitted_files<br />
<br />
def submitted_files<br />
files(self.path) if self.directory_num<br />
end<br />
<br />
* files(directory)<br />
<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = Array.new<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each{|f| files << f}<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
* submitted_files()<br />
<br />
def submitted_files()<br />
files = Array.new<br />
if(self.directory_num)<br />
files = files(self.path)<br />
end<br />
return files<br />
end<br />
<br />
* dir_path<br />
<br />
def dir_path<br />
assignment.try :directory_path<br />
end<br />
<br />
===Remove unused methods===<br />
The following methods have been removed as they were not being used by the application.<br />
<br />
'''def average_score_per_assignment(assignment_id)'''<br />
<br />
def average_score_per_assignment(assignment_id)<br />
return 0 if self.response_maps.size == 0<br />
<br />
sum_of_scores = 0<br />
<br />
self.response_maps.metareview_response_maps.each do |metaresponse_map|<br />
if !metaresponse_map.response.empty? && response_map == assignment_id then<br />
sum_of_scores = sum_of_scores + response_map.response.last.average_score<br />
end<br />
end<br />
<br />
(sum_of_scores / self.response_maps.size).to_i<br />
end<br />
<br />
<br />
'''def quiz_taken_by?(contributor, reviewer)'''<br />
<br />
def quiz_taken_by?(contributor, reviewer)<br />
quiz_id = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
return QuizResponseMap.where(['reviewee_id = ? AND reviewer_id = ? AND reviewed_object_id = ?',<br />
self.id, reviewer.id, quiz_id]).count > 0<br />
end<br />
<br />
<br />
'''def has_quiz?'''<br />
<br />
def has_quiz?<br />
return !QuizQuestionnaire.find_by_instructor_id(self.id).nil?<br />
end<br />
<br />
<br />
'''def reviewees'''<br />
<br />
def reviewees<br />
reviewees = []<br />
rmaps = ResponseMap.all(conditions: ["reviewer_id = #{self.id} && type = 'ReviewResponseMap'"])<br />
rmaps.each { |rm| reviewees.concat(AssignmentTeam.find(rm.reviewee_id).participants) }<br />
<br />
reviewees<br />
end<br />
<br />
<br />
'''def two_node_cycles'''<br />
<br />
def two_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap|<br />
if ap.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap).nil? ? next : s01 = self.reviews_by_reviewer(ap).get_total_score<br />
ap.reviews_by_reviewer(self).nil? ? next : s10 = ap.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap, s10]])<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def three_node_cycles'''<br />
<br />
def three_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap1|<br />
ap1.reviewers.each do |ap2|<br />
if ap2.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap1).nil? ? next : s01 = self.reviews_by_reviewer(ap1).get_total_score<br />
ap1.reviews_by_reviewer(ap2).nil? ? next : s12 = ap1.reviews_by_reviewer(ap2).get_total_score<br />
ap2.reviews_by_reviewer(self).nil? ? next : s20 = ap2.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap1, s12], [ap2, s20]])<br />
end<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def four_node_cycles'''<br />
<br />
def four_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap1|<br />
ap1.reviewers.each do |ap2|<br />
ap2.reviewers.each do |ap3|<br />
if ap3.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap1).nil? ? next : s01 = self.reviews_by_reviewer(ap1).get_total_score<br />
ap1.reviews_by_reviewer(ap2).nil? ? next : s12 = ap1.reviews_by_reviewer(ap2).get_total_score<br />
ap2.reviews_by_reviewer(ap3).nil? ? next : s23 = ap2.reviews_by_reviewer(ap3).get_total_score<br />
ap3.reviews_by_reviewer(self).nil? ? next : s30 = ap3.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap1, s12], [ap2, s23], [ap3, s30]])<br />
end<br />
end<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def cycle_similarity_score(cycle)'''<br />
<br />
def cycle_similarity_score(cycle)<br />
similarity_score = 0.0<br />
count = 0.0<br />
<br />
0 ... cycle.size-1.each do |pivot|<br />
pivot_score = cycle[pivot][1]<br />
similarity_score = similarity_score + (pivot_score - cycle[other][1]).abs<br />
count = count + 1.0<br />
end<br />
<br />
similarity_score = similarity_score / count unless count == 0.0<br />
similarity_score<br />
end<br />
<br />
<br />
'''def cycle_deviation_score(cycle)'''<br />
<br />
def cycle_deviation_score(cycle)<br />
deviation_score = 0.0<br />
count = 0.0<br />
<br />
0 ... cycle.size.each do |member|<br />
participant = AssignmentParticipant.find(cycle[member][0].id)<br />
total_score = participant.get_review_score<br />
deviation_score = deviation_score + (total_score - cycle[member][1]).abs<br />
count = count + 1.0<br />
end<br />
<br />
deviation_score = deviation_score / count unless count == 0.0<br />
deviation_score<br />
end<br />
<br />
<br />
'''def compute_quiz_scores(scores)'''<br />
<br />
def compute_quiz_scores(scores)<br />
total = 0<br />
if scores[:quiz][:scores][:avg]<br />
return scores[:quiz][:scores][:avg] * 100 / 100.to_f<br />
else<br />
return 0<br />
end<br />
return total<br />
end<br />
<br />
<br />
'''def review_response_maps'''<br />
<br />
def review_response_maps<br />
participant = Participant.find(id)<br />
team_id = TeamsUser.team_id(participant.parent_id, participant.user_id)<br />
ReviewResponseMap.where(reviewee_id: team_id, reviewed_object_id: assignment.id)<br />
end<br />
<br />
<br />
'''def members'''<br />
<br />
def members<br />
team.try :participants<br />
end<br />
<br />
<br />
'''def get_hash(time_stamp)'''<br />
<br />
def get_hash(time_stamp)<br />
# first generate a hash from the assignment name itself<br />
hash_data = Digest::SHA1.digest(self.assignment.name.to_s)<br />
<br />
# second generate a hash from the first hash plus the user name and time stamp<br />
sign = hash_data + self.user.name.to_s + time_stamp.strftime("%Y-%m-%d %H:%M:%S")<br />
Digest::SHA1.digest(sign)<br />
end<br />
<br />
===Review methods===<br />
* The bookmark_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''BookmarkRatingQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def bookmark_reviews<br />
BookmarkRatingResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
BookmarkRatingResponseMap.get_assessments_for(participant) # participant.bookmark_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
* The teammate_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''TeammateReviewQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def teammate_reviews<br />
TeammateReviewResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
TeammateReviewResponseMap.get_assessments_for(participant) #participant.teammate_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109411CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-26T15:38:23Z<p>Cshao: </p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
==Test First Development==<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by_assignment_id_and_questionnaire_id(self.assignment.id, questionnaire.id).used_in_round<br />
#create symbol for "varying rubrics" feature -Yang<br />
if(round!=nil)<br />
questionnaire_symbol = (questionnaire.symbol.to_s+round.to_s).to_sym<br />
else<br />
questionnaire_symbol = questionnaire.symbol<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
if round==nil<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_for(self)<br />
else<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_round_for(self,round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
#merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = Hash.new<br />
scores[review_sym][:assessments] = Array.new<br />
scores[review_sym][:scores] = Hash.new<br />
scores[review_sym][:scores][:max] = -999999999<br />
scores[review_sym][:scores][:min] = 999999999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.get_review_rounds<br />
round_sym = ("review"+i.to_s).to_sym<br />
if scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].length==0<br />
next<br />
end<br />
length_of_assessments=scores[round_sym][:assessments].length.to_f<br />
<br />
scores[review_sym][:assessments]+=scores[round_sym][:assessments]<br />
<br />
if(scores[round_sym][:scores][:max]!=nil && scores[review_sym][:scores][:max]<scores[round_sym][:scores][:max])<br />
scores[review_sym][:scores][:max]= scores[round_sym][:scores][:max]<br />
end<br />
if(scores[round_sym][:scores][:min]!= nil && scores[review_sym][:scores][:min]>scores[round_sym][:scores][:min])<br />
scores[review_sym][:scores][:min]= scores[round_sym][:scores][:min]<br />
end<br />
if(scores[round_sym][:scores][:avg]!=nil)<br />
total_score += scores[round_sym][:scores][:avg]*length_of_assessments<br />
end<br />
end<br />
<br />
if scores[review_sym][:scores][:max] == -999999999 && scores[review_sym][:scores][:min] == 999999999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
<br />
scores[review_sym][:scores][:avg] = total_score/scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
if !topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
quiz_responses = Array.new<br />
quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
quiz_response_mappings.each do |qmapping|<br />
if (qmapping.response)<br />
quiz_responses << qmapping.response<br />
end<br />
end<br />
#scores[:quiz] = Hash.new<br />
#scores[:quiz][:assessments] = quiz_responses<br />
#scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
#scores[:total_score] += compute_quiz_scores(scores)<br />
<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
total_score = scores[:total_score]<br />
if total_score > 100<br />
total_score = 100<br />
end<br />
scores[:total_score] = total_score<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
<br />
assignment_questionnaires(questions, scores)<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
merge_scores(scores)<br />
<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
if !topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
quiz_responses = Array.new<br />
quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
quiz_response_mappings.each do |qmapping|<br />
if (qmapping.response)<br />
quiz_responses << qmapping.response<br />
end<br />
end<br />
#scores[:quiz] = Hash.new<br />
#scores[:quiz][:assessments] = quiz_responses<br />
#scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
#scores[:total_score] += compute_quiz_scores(scores)<br />
<br />
calculate_scores(scores)<br />
end<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by_assignment_id_and_questionnaire_id(self.assignment.id, questionnaire.id).used_in_round<br />
#create symbol for "varying rubrics" feature -Yang<br />
if(round!=nil)<br />
questionnaire_symbol = (questionnaire.symbol.to_s+round.to_s).to_sym<br />
else<br />
questionnaire_symbol = questionnaire.symbol<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
if round==nil<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_for(self)<br />
else<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_round_for(self,round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
#merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = Hash.new<br />
scores[review_sym][:assessments] = Array.new<br />
scores[review_sym][:scores] = Hash.new<br />
scores[review_sym][:scores][:max] = -999999999<br />
scores[review_sym][:scores][:min] = 999999999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.get_review_rounds<br />
round_sym = ("review"+i.to_s).to_sym<br />
if scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].length==0<br />
next<br />
end<br />
length_of_assessments=scores[round_sym][:assessments].length.to_f<br />
<br />
scores[review_sym][:assessments]+=scores[round_sym][:assessments]<br />
<br />
if(scores[round_sym][:scores][:max]!=nil && scores[review_sym][:scores][:max]<scores[round_sym][:scores][:max])<br />
scores[review_sym][:scores][:max]= scores[round_sym][:scores][:max]<br />
end<br />
if(scores[round_sym][:scores][:min]!= nil && scores[review_sym][:scores][:min]>scores[round_sym][:scores][:min])<br />
scores[review_sym][:scores][:min]= scores[round_sym][:scores][:min]<br />
end<br />
if(scores[round_sym][:scores][:avg]!=nil)<br />
total_score += scores[round_sym][:scores][:avg]*length_of_assessments<br />
end<br />
end<br />
<br />
if scores[review_sym][:scores][:max] == -999999999 && scores[review_sym][:scores][:min] == 999999999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
<br />
scores[review_sym][:scores][:avg] = total_score/scores[review_sym][:assessments].length.to_f<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def calculate_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
total_score = scores[:total_score]<br />
if total_score > 100<br />
total_score = 100<br />
end<br />
scores[:total_score] = total_score<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===set_handle method===<br />
The set_handle method had an unncessary ELSIF statement which was performing the same action '''self.handle = self.user.name'''. This has been clubbed as an OR condition to the IF statement and the first ELSIF statement has been removed.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def set_handle<br />
if self.user.handle == nil or self.user.handle == ""<br />
self.handle = self.user.name<br />
elsif AssignmentParticipant.where(parent_id: self.assignment.id, handle: self.user.handle).length > 0<br />
self.handle = self.user.name<br />
else<br />
self.handle = self.user.handle<br />
end<br />
self.save!<br />
end<br />
<br />
||def set_handle<br />
if self.user.handle == nil or self.user.handle == "" or AssignmentParticipant.where(parent_id: self.assignment.id, handle: self.user.handle).length > 0<br />
self.handle = self.user.name<br />
else<br />
self.handle = self.user.handle<br />
end<br />
self.save!<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===File and directory methods===<br />
The files and directory methods from AssignmentParticipant model have been moved to the '''FileHelper''' module.<br />
The methods '''files''', '''submitted_files''' and '''dir_path''' are appropriate for the '''FileHelper' module and hence been moved there.<br />
The below line was added to the AssignmentParticipant model.<br />
include FileHelper<br />
<br />
The AssignmentParticipant class would look like<br />
class AssignmentParticipant < Participant<br />
require 'wiki_helper'<br />
'''include FileHelper'''<br />
Methods moved to FileHelper:<br />
<br />
* submitted_files<br />
<br />
def submitted_files<br />
files(self.path) if self.directory_num<br />
end<br />
<br />
* files(directory)<br />
<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = Array.new<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each{|f| files << f}<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
* submitted_files()<br />
<br />
def submitted_files()<br />
files = Array.new<br />
if(self.directory_num)<br />
files = files(self.path)<br />
end<br />
return files<br />
end<br />
<br />
* dir_path<br />
<br />
def dir_path<br />
assignment.try :directory_path<br />
end<br />
<br />
===Remove unused methods===<br />
The following methods have been removed as they were not being used by the application.<br />
<br />
'''def average_score_per_assignment(assignment_id)'''<br />
<br />
def average_score_per_assignment(assignment_id)<br />
return 0 if self.response_maps.size == 0<br />
<br />
sum_of_scores = 0<br />
<br />
self.response_maps.metareview_response_maps.each do |metaresponse_map|<br />
if !metaresponse_map.response.empty? && response_map == assignment_id then<br />
sum_of_scores = sum_of_scores + response_map.response.last.average_score<br />
end<br />
end<br />
<br />
(sum_of_scores / self.response_maps.size).to_i<br />
end<br />
<br />
<br />
'''def quiz_taken_by?(contributor, reviewer)'''<br />
<br />
def quiz_taken_by?(contributor, reviewer)<br />
quiz_id = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
return QuizResponseMap.where(['reviewee_id = ? AND reviewer_id = ? AND reviewed_object_id = ?',<br />
self.id, reviewer.id, quiz_id]).count > 0<br />
end<br />
<br />
<br />
'''def has_quiz?'''<br />
<br />
def has_quiz?<br />
return !QuizQuestionnaire.find_by_instructor_id(self.id).nil?<br />
end<br />
<br />
<br />
'''def reviewees'''<br />
<br />
def reviewees<br />
reviewees = []<br />
rmaps = ResponseMap.all(conditions: ["reviewer_id = #{self.id} && type = 'ReviewResponseMap'"])<br />
rmaps.each { |rm| reviewees.concat(AssignmentTeam.find(rm.reviewee_id).participants) }<br />
<br />
reviewees<br />
end<br />
<br />
<br />
'''def two_node_cycles'''<br />
<br />
def two_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap|<br />
if ap.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap).nil? ? next : s01 = self.reviews_by_reviewer(ap).get_total_score<br />
ap.reviews_by_reviewer(self).nil? ? next : s10 = ap.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap, s10]])<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def three_node_cycles'''<br />
<br />
def three_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap1|<br />
ap1.reviewers.each do |ap2|<br />
if ap2.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap1).nil? ? next : s01 = self.reviews_by_reviewer(ap1).get_total_score<br />
ap1.reviews_by_reviewer(ap2).nil? ? next : s12 = ap1.reviews_by_reviewer(ap2).get_total_score<br />
ap2.reviews_by_reviewer(self).nil? ? next : s20 = ap2.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap1, s12], [ap2, s20]])<br />
end<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def four_node_cycles'''<br />
<br />
def four_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap1|<br />
ap1.reviewers.each do |ap2|<br />
ap2.reviewers.each do |ap3|<br />
if ap3.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap1).nil? ? next : s01 = self.reviews_by_reviewer(ap1).get_total_score<br />
ap1.reviews_by_reviewer(ap2).nil? ? next : s12 = ap1.reviews_by_reviewer(ap2).get_total_score<br />
ap2.reviews_by_reviewer(ap3).nil? ? next : s23 = ap2.reviews_by_reviewer(ap3).get_total_score<br />
ap3.reviews_by_reviewer(self).nil? ? next : s30 = ap3.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap1, s12], [ap2, s23], [ap3, s30]])<br />
end<br />
end<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def cycle_similarity_score(cycle)'''<br />
<br />
def cycle_similarity_score(cycle)<br />
similarity_score = 0.0<br />
count = 0.0<br />
<br />
0 ... cycle.size-1.each do |pivot|<br />
pivot_score = cycle[pivot][1]<br />
similarity_score = similarity_score + (pivot_score - cycle[other][1]).abs<br />
count = count + 1.0<br />
end<br />
<br />
similarity_score = similarity_score / count unless count == 0.0<br />
similarity_score<br />
end<br />
<br />
<br />
'''def cycle_deviation_score(cycle)'''<br />
<br />
def cycle_deviation_score(cycle)<br />
deviation_score = 0.0<br />
count = 0.0<br />
<br />
0 ... cycle.size.each do |member|<br />
participant = AssignmentParticipant.find(cycle[member][0].id)<br />
total_score = participant.get_review_score<br />
deviation_score = deviation_score + (total_score - cycle[member][1]).abs<br />
count = count + 1.0<br />
end<br />
<br />
deviation_score = deviation_score / count unless count == 0.0<br />
deviation_score<br />
end<br />
<br />
<br />
'''def compute_quiz_scores(scores)'''<br />
<br />
def compute_quiz_scores(scores)<br />
total = 0<br />
if scores[:quiz][:scores][:avg]<br />
return scores[:quiz][:scores][:avg] * 100 / 100.to_f<br />
else<br />
return 0<br />
end<br />
return total<br />
end<br />
<br />
<br />
'''def review_response_maps'''<br />
<br />
def review_response_maps<br />
participant = Participant.find(id)<br />
team_id = TeamsUser.team_id(participant.parent_id, participant.user_id)<br />
ReviewResponseMap.where(reviewee_id: team_id, reviewed_object_id: assignment.id)<br />
end<br />
<br />
<br />
'''def members'''<br />
<br />
def members<br />
team.try :participants<br />
end<br />
<br />
<br />
'''def get_hash(time_stamp)'''<br />
<br />
def get_hash(time_stamp)<br />
# first generate a hash from the assignment name itself<br />
hash_data = Digest::SHA1.digest(self.assignment.name.to_s)<br />
<br />
# second generate a hash from the first hash plus the user name and time stamp<br />
sign = hash_data + self.user.name.to_s + time_stamp.strftime("%Y-%m-%d %H:%M:%S")<br />
Digest::SHA1.digest(sign)<br />
end<br />
<br />
===Review methods===<br />
* The bookmark_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''BookmarkRatingQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def bookmark_reviews<br />
BookmarkRatingResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
BookmarkRatingResponseMap.get_assessments_for(participant) # participant.bookmark_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
* The teammate_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''TeammateReviewQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def teammate_reviews<br />
TeammateReviewResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
TeammateReviewResponseMap.get_assessments_for(participant) #participant.teammate_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109410CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-26T15:34:53Z<p>Cshao: /* 1 Introduction to Expertiza */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by_assignment_id_and_questionnaire_id(self.assignment.id, questionnaire.id).used_in_round<br />
#create symbol for "varying rubrics" feature -Yang<br />
if(round!=nil)<br />
questionnaire_symbol = (questionnaire.symbol.to_s+round.to_s).to_sym<br />
else<br />
questionnaire_symbol = questionnaire.symbol<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
if round==nil<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_for(self)<br />
else<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_round_for(self,round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
#merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = Hash.new<br />
scores[review_sym][:assessments] = Array.new<br />
scores[review_sym][:scores] = Hash.new<br />
scores[review_sym][:scores][:max] = -999999999<br />
scores[review_sym][:scores][:min] = 999999999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.get_review_rounds<br />
round_sym = ("review"+i.to_s).to_sym<br />
if scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].length==0<br />
next<br />
end<br />
length_of_assessments=scores[round_sym][:assessments].length.to_f<br />
<br />
scores[review_sym][:assessments]+=scores[round_sym][:assessments]<br />
<br />
if(scores[round_sym][:scores][:max]!=nil && scores[review_sym][:scores][:max]<scores[round_sym][:scores][:max])<br />
scores[review_sym][:scores][:max]= scores[round_sym][:scores][:max]<br />
end<br />
if(scores[round_sym][:scores][:min]!= nil && scores[review_sym][:scores][:min]>scores[round_sym][:scores][:min])<br />
scores[review_sym][:scores][:min]= scores[round_sym][:scores][:min]<br />
end<br />
if(scores[round_sym][:scores][:avg]!=nil)<br />
total_score += scores[round_sym][:scores][:avg]*length_of_assessments<br />
end<br />
end<br />
<br />
if scores[review_sym][:scores][:max] == -999999999 && scores[review_sym][:scores][:min] == 999999999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
<br />
scores[review_sym][:scores][:avg] = total_score/scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
if !topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
quiz_responses = Array.new<br />
quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
quiz_response_mappings.each do |qmapping|<br />
if (qmapping.response)<br />
quiz_responses << qmapping.response<br />
end<br />
end<br />
#scores[:quiz] = Hash.new<br />
#scores[:quiz][:assessments] = quiz_responses<br />
#scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
#scores[:total_score] += compute_quiz_scores(scores)<br />
<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
total_score = scores[:total_score]<br />
if total_score > 100<br />
total_score = 100<br />
end<br />
scores[:total_score] = total_score<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
<br />
assignment_questionnaires(questions, scores)<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
merge_scores(scores)<br />
<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
if !topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
quiz_responses = Array.new<br />
quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
quiz_response_mappings.each do |qmapping|<br />
if (qmapping.response)<br />
quiz_responses << qmapping.response<br />
end<br />
end<br />
#scores[:quiz] = Hash.new<br />
#scores[:quiz][:assessments] = quiz_responses<br />
#scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
#scores[:total_score] += compute_quiz_scores(scores)<br />
<br />
calculate_scores(scores)<br />
end<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by_assignment_id_and_questionnaire_id(self.assignment.id, questionnaire.id).used_in_round<br />
#create symbol for "varying rubrics" feature -Yang<br />
if(round!=nil)<br />
questionnaire_symbol = (questionnaire.symbol.to_s+round.to_s).to_sym<br />
else<br />
questionnaire_symbol = questionnaire.symbol<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
if round==nil<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_for(self)<br />
else<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_round_for(self,round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
#merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = Hash.new<br />
scores[review_sym][:assessments] = Array.new<br />
scores[review_sym][:scores] = Hash.new<br />
scores[review_sym][:scores][:max] = -999999999<br />
scores[review_sym][:scores][:min] = 999999999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.get_review_rounds<br />
round_sym = ("review"+i.to_s).to_sym<br />
if scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].length==0<br />
next<br />
end<br />
length_of_assessments=scores[round_sym][:assessments].length.to_f<br />
<br />
scores[review_sym][:assessments]+=scores[round_sym][:assessments]<br />
<br />
if(scores[round_sym][:scores][:max]!=nil && scores[review_sym][:scores][:max]<scores[round_sym][:scores][:max])<br />
scores[review_sym][:scores][:max]= scores[round_sym][:scores][:max]<br />
end<br />
if(scores[round_sym][:scores][:min]!= nil && scores[review_sym][:scores][:min]>scores[round_sym][:scores][:min])<br />
scores[review_sym][:scores][:min]= scores[round_sym][:scores][:min]<br />
end<br />
if(scores[round_sym][:scores][:avg]!=nil)<br />
total_score += scores[round_sym][:scores][:avg]*length_of_assessments<br />
end<br />
end<br />
<br />
if scores[review_sym][:scores][:max] == -999999999 && scores[review_sym][:scores][:min] == 999999999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
<br />
scores[review_sym][:scores][:avg] = total_score/scores[review_sym][:assessments].length.to_f<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def calculate_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
total_score = scores[:total_score]<br />
if total_score > 100<br />
total_score = 100<br />
end<br />
scores[:total_score] = total_score<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===set_handle method===<br />
The set_handle method had an unncessary ELSIF statement which was performing the same action '''self.handle = self.user.name'''. This has been clubbed as an OR condition to the IF statement and the first ELSIF statement has been removed.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def set_handle<br />
if self.user.handle == nil or self.user.handle == ""<br />
self.handle = self.user.name<br />
elsif AssignmentParticipant.where(parent_id: self.assignment.id, handle: self.user.handle).length > 0<br />
self.handle = self.user.name<br />
else<br />
self.handle = self.user.handle<br />
end<br />
self.save!<br />
end<br />
<br />
||def set_handle<br />
if self.user.handle == nil or self.user.handle == "" or AssignmentParticipant.where(parent_id: self.assignment.id, handle: self.user.handle).length > 0<br />
self.handle = self.user.name<br />
else<br />
self.handle = self.user.handle<br />
end<br />
self.save!<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===File and directory methods===<br />
The files and directory methods from AssignmentParticipant model have been moved to the '''FileHelper''' module.<br />
The methods '''files''', '''submitted_files''' and '''dir_path''' are appropriate for the '''FileHelper' module and hence been moved there.<br />
The below line was added to the AssignmentParticipant model.<br />
include FileHelper<br />
<br />
The AssignmentParticipant class would look like<br />
class AssignmentParticipant < Participant<br />
require 'wiki_helper'<br />
'''include FileHelper'''<br />
Methods moved to FileHelper:<br />
<br />
* submitted_files<br />
<br />
def submitted_files<br />
files(self.path) if self.directory_num<br />
end<br />
<br />
* files(directory)<br />
<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = Array.new<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each{|f| files << f}<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
* submitted_files()<br />
<br />
def submitted_files()<br />
files = Array.new<br />
if(self.directory_num)<br />
files = files(self.path)<br />
end<br />
return files<br />
end<br />
<br />
* dir_path<br />
<br />
def dir_path<br />
assignment.try :directory_path<br />
end<br />
<br />
===Remove unused methods===<br />
The following methods have been removed as they were not being used by the application.<br />
<br />
'''def average_score_per_assignment(assignment_id)'''<br />
<br />
def average_score_per_assignment(assignment_id)<br />
return 0 if self.response_maps.size == 0<br />
<br />
sum_of_scores = 0<br />
<br />
self.response_maps.metareview_response_maps.each do |metaresponse_map|<br />
if !metaresponse_map.response.empty? && response_map == assignment_id then<br />
sum_of_scores = sum_of_scores + response_map.response.last.average_score<br />
end<br />
end<br />
<br />
(sum_of_scores / self.response_maps.size).to_i<br />
end<br />
<br />
<br />
'''def quiz_taken_by?(contributor, reviewer)'''<br />
<br />
def quiz_taken_by?(contributor, reviewer)<br />
quiz_id = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
return QuizResponseMap.where(['reviewee_id = ? AND reviewer_id = ? AND reviewed_object_id = ?',<br />
self.id, reviewer.id, quiz_id]).count > 0<br />
end<br />
<br />
<br />
'''def has_quiz?'''<br />
<br />
def has_quiz?<br />
return !QuizQuestionnaire.find_by_instructor_id(self.id).nil?<br />
end<br />
<br />
<br />
'''def reviewees'''<br />
<br />
def reviewees<br />
reviewees = []<br />
rmaps = ResponseMap.all(conditions: ["reviewer_id = #{self.id} && type = 'ReviewResponseMap'"])<br />
rmaps.each { |rm| reviewees.concat(AssignmentTeam.find(rm.reviewee_id).participants) }<br />
<br />
reviewees<br />
end<br />
<br />
<br />
'''def two_node_cycles'''<br />
<br />
def two_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap|<br />
if ap.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap).nil? ? next : s01 = self.reviews_by_reviewer(ap).get_total_score<br />
ap.reviews_by_reviewer(self).nil? ? next : s10 = ap.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap, s10]])<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def three_node_cycles'''<br />
<br />
def three_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap1|<br />
ap1.reviewers.each do |ap2|<br />
if ap2.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap1).nil? ? next : s01 = self.reviews_by_reviewer(ap1).get_total_score<br />
ap1.reviews_by_reviewer(ap2).nil? ? next : s12 = ap1.reviews_by_reviewer(ap2).get_total_score<br />
ap2.reviews_by_reviewer(self).nil? ? next : s20 = ap2.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap1, s12], [ap2, s20]])<br />
end<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def four_node_cycles'''<br />
<br />
def four_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap1|<br />
ap1.reviewers.each do |ap2|<br />
ap2.reviewers.each do |ap3|<br />
if ap3.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap1).nil? ? next : s01 = self.reviews_by_reviewer(ap1).get_total_score<br />
ap1.reviews_by_reviewer(ap2).nil? ? next : s12 = ap1.reviews_by_reviewer(ap2).get_total_score<br />
ap2.reviews_by_reviewer(ap3).nil? ? next : s23 = ap2.reviews_by_reviewer(ap3).get_total_score<br />
ap3.reviews_by_reviewer(self).nil? ? next : s30 = ap3.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap1, s12], [ap2, s23], [ap3, s30]])<br />
end<br />
end<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def cycle_similarity_score(cycle)'''<br />
<br />
def cycle_similarity_score(cycle)<br />
similarity_score = 0.0<br />
count = 0.0<br />
<br />
0 ... cycle.size-1.each do |pivot|<br />
pivot_score = cycle[pivot][1]<br />
similarity_score = similarity_score + (pivot_score - cycle[other][1]).abs<br />
count = count + 1.0<br />
end<br />
<br />
similarity_score = similarity_score / count unless count == 0.0<br />
similarity_score<br />
end<br />
<br />
<br />
'''def cycle_deviation_score(cycle)'''<br />
<br />
def cycle_deviation_score(cycle)<br />
deviation_score = 0.0<br />
count = 0.0<br />
<br />
0 ... cycle.size.each do |member|<br />
participant = AssignmentParticipant.find(cycle[member][0].id)<br />
total_score = participant.get_review_score<br />
deviation_score = deviation_score + (total_score - cycle[member][1]).abs<br />
count = count + 1.0<br />
end<br />
<br />
deviation_score = deviation_score / count unless count == 0.0<br />
deviation_score<br />
end<br />
<br />
<br />
'''def compute_quiz_scores(scores)'''<br />
<br />
def compute_quiz_scores(scores)<br />
total = 0<br />
if scores[:quiz][:scores][:avg]<br />
return scores[:quiz][:scores][:avg] * 100 / 100.to_f<br />
else<br />
return 0<br />
end<br />
return total<br />
end<br />
<br />
<br />
'''def review_response_maps'''<br />
<br />
def review_response_maps<br />
participant = Participant.find(id)<br />
team_id = TeamsUser.team_id(participant.parent_id, participant.user_id)<br />
ReviewResponseMap.where(reviewee_id: team_id, reviewed_object_id: assignment.id)<br />
end<br />
<br />
<br />
'''def members'''<br />
<br />
def members<br />
team.try :participants<br />
end<br />
<br />
<br />
'''def get_hash(time_stamp)'''<br />
<br />
def get_hash(time_stamp)<br />
# first generate a hash from the assignment name itself<br />
hash_data = Digest::SHA1.digest(self.assignment.name.to_s)<br />
<br />
# second generate a hash from the first hash plus the user name and time stamp<br />
sign = hash_data + self.user.name.to_s + time_stamp.strftime("%Y-%m-%d %H:%M:%S")<br />
Digest::SHA1.digest(sign)<br />
end<br />
<br />
===Review methods===<br />
* The bookmark_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''BookmarkRatingQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def bookmark_reviews<br />
BookmarkRatingResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
BookmarkRatingResponseMap.get_assessments_for(participant) # participant.bookmark_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
* The teammate_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''TeammateReviewQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def teammate_reviews<br />
TeammateReviewResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
TeammateReviewResponseMap.get_assessments_for(participant) #participant.teammate_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109409CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-26T15:34:43Z<p>Cshao: /* 2 Why refactoring? */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==1 Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by_assignment_id_and_questionnaire_id(self.assignment.id, questionnaire.id).used_in_round<br />
#create symbol for "varying rubrics" feature -Yang<br />
if(round!=nil)<br />
questionnaire_symbol = (questionnaire.symbol.to_s+round.to_s).to_sym<br />
else<br />
questionnaire_symbol = questionnaire.symbol<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
if round==nil<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_for(self)<br />
else<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_round_for(self,round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
#merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = Hash.new<br />
scores[review_sym][:assessments] = Array.new<br />
scores[review_sym][:scores] = Hash.new<br />
scores[review_sym][:scores][:max] = -999999999<br />
scores[review_sym][:scores][:min] = 999999999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.get_review_rounds<br />
round_sym = ("review"+i.to_s).to_sym<br />
if scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].length==0<br />
next<br />
end<br />
length_of_assessments=scores[round_sym][:assessments].length.to_f<br />
<br />
scores[review_sym][:assessments]+=scores[round_sym][:assessments]<br />
<br />
if(scores[round_sym][:scores][:max]!=nil && scores[review_sym][:scores][:max]<scores[round_sym][:scores][:max])<br />
scores[review_sym][:scores][:max]= scores[round_sym][:scores][:max]<br />
end<br />
if(scores[round_sym][:scores][:min]!= nil && scores[review_sym][:scores][:min]>scores[round_sym][:scores][:min])<br />
scores[review_sym][:scores][:min]= scores[round_sym][:scores][:min]<br />
end<br />
if(scores[round_sym][:scores][:avg]!=nil)<br />
total_score += scores[round_sym][:scores][:avg]*length_of_assessments<br />
end<br />
end<br />
<br />
if scores[review_sym][:scores][:max] == -999999999 && scores[review_sym][:scores][:min] == 999999999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
<br />
scores[review_sym][:scores][:avg] = total_score/scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
if !topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
quiz_responses = Array.new<br />
quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
quiz_response_mappings.each do |qmapping|<br />
if (qmapping.response)<br />
quiz_responses << qmapping.response<br />
end<br />
end<br />
#scores[:quiz] = Hash.new<br />
#scores[:quiz][:assessments] = quiz_responses<br />
#scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
#scores[:total_score] += compute_quiz_scores(scores)<br />
<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
total_score = scores[:total_score]<br />
if total_score > 100<br />
total_score = 100<br />
end<br />
scores[:total_score] = total_score<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
<br />
assignment_questionnaires(questions, scores)<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
merge_scores(scores)<br />
<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
if !topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
quiz_responses = Array.new<br />
quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
quiz_response_mappings.each do |qmapping|<br />
if (qmapping.response)<br />
quiz_responses << qmapping.response<br />
end<br />
end<br />
#scores[:quiz] = Hash.new<br />
#scores[:quiz][:assessments] = quiz_responses<br />
#scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
#scores[:total_score] += compute_quiz_scores(scores)<br />
<br />
calculate_scores(scores)<br />
end<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by_assignment_id_and_questionnaire_id(self.assignment.id, questionnaire.id).used_in_round<br />
#create symbol for "varying rubrics" feature -Yang<br />
if(round!=nil)<br />
questionnaire_symbol = (questionnaire.symbol.to_s+round.to_s).to_sym<br />
else<br />
questionnaire_symbol = questionnaire.symbol<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
if round==nil<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_for(self)<br />
else<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_round_for(self,round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
#merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = Hash.new<br />
scores[review_sym][:assessments] = Array.new<br />
scores[review_sym][:scores] = Hash.new<br />
scores[review_sym][:scores][:max] = -999999999<br />
scores[review_sym][:scores][:min] = 999999999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.get_review_rounds<br />
round_sym = ("review"+i.to_s).to_sym<br />
if scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].length==0<br />
next<br />
end<br />
length_of_assessments=scores[round_sym][:assessments].length.to_f<br />
<br />
scores[review_sym][:assessments]+=scores[round_sym][:assessments]<br />
<br />
if(scores[round_sym][:scores][:max]!=nil && scores[review_sym][:scores][:max]<scores[round_sym][:scores][:max])<br />
scores[review_sym][:scores][:max]= scores[round_sym][:scores][:max]<br />
end<br />
if(scores[round_sym][:scores][:min]!= nil && scores[review_sym][:scores][:min]>scores[round_sym][:scores][:min])<br />
scores[review_sym][:scores][:min]= scores[round_sym][:scores][:min]<br />
end<br />
if(scores[round_sym][:scores][:avg]!=nil)<br />
total_score += scores[round_sym][:scores][:avg]*length_of_assessments<br />
end<br />
end<br />
<br />
if scores[review_sym][:scores][:max] == -999999999 && scores[review_sym][:scores][:min] == 999999999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
<br />
scores[review_sym][:scores][:avg] = total_score/scores[review_sym][:assessments].length.to_f<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def calculate_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
total_score = scores[:total_score]<br />
if total_score > 100<br />
total_score = 100<br />
end<br />
scores[:total_score] = total_score<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===set_handle method===<br />
The set_handle method had an unncessary ELSIF statement which was performing the same action '''self.handle = self.user.name'''. This has been clubbed as an OR condition to the IF statement and the first ELSIF statement has been removed.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def set_handle<br />
if self.user.handle == nil or self.user.handle == ""<br />
self.handle = self.user.name<br />
elsif AssignmentParticipant.where(parent_id: self.assignment.id, handle: self.user.handle).length > 0<br />
self.handle = self.user.name<br />
else<br />
self.handle = self.user.handle<br />
end<br />
self.save!<br />
end<br />
<br />
||def set_handle<br />
if self.user.handle == nil or self.user.handle == "" or AssignmentParticipant.where(parent_id: self.assignment.id, handle: self.user.handle).length > 0<br />
self.handle = self.user.name<br />
else<br />
self.handle = self.user.handle<br />
end<br />
self.save!<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===File and directory methods===<br />
The files and directory methods from AssignmentParticipant model have been moved to the '''FileHelper''' module.<br />
The methods '''files''', '''submitted_files''' and '''dir_path''' are appropriate for the '''FileHelper' module and hence been moved there.<br />
The below line was added to the AssignmentParticipant model.<br />
include FileHelper<br />
<br />
The AssignmentParticipant class would look like<br />
class AssignmentParticipant < Participant<br />
require 'wiki_helper'<br />
'''include FileHelper'''<br />
Methods moved to FileHelper:<br />
<br />
* submitted_files<br />
<br />
def submitted_files<br />
files(self.path) if self.directory_num<br />
end<br />
<br />
* files(directory)<br />
<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = Array.new<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each{|f| files << f}<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
* submitted_files()<br />
<br />
def submitted_files()<br />
files = Array.new<br />
if(self.directory_num)<br />
files = files(self.path)<br />
end<br />
return files<br />
end<br />
<br />
* dir_path<br />
<br />
def dir_path<br />
assignment.try :directory_path<br />
end<br />
<br />
===Remove unused methods===<br />
The following methods have been removed as they were not being used by the application.<br />
<br />
'''def average_score_per_assignment(assignment_id)'''<br />
<br />
def average_score_per_assignment(assignment_id)<br />
return 0 if self.response_maps.size == 0<br />
<br />
sum_of_scores = 0<br />
<br />
self.response_maps.metareview_response_maps.each do |metaresponse_map|<br />
if !metaresponse_map.response.empty? && response_map == assignment_id then<br />
sum_of_scores = sum_of_scores + response_map.response.last.average_score<br />
end<br />
end<br />
<br />
(sum_of_scores / self.response_maps.size).to_i<br />
end<br />
<br />
<br />
'''def quiz_taken_by?(contributor, reviewer)'''<br />
<br />
def quiz_taken_by?(contributor, reviewer)<br />
quiz_id = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
return QuizResponseMap.where(['reviewee_id = ? AND reviewer_id = ? AND reviewed_object_id = ?',<br />
self.id, reviewer.id, quiz_id]).count > 0<br />
end<br />
<br />
<br />
'''def has_quiz?'''<br />
<br />
def has_quiz?<br />
return !QuizQuestionnaire.find_by_instructor_id(self.id).nil?<br />
end<br />
<br />
<br />
'''def reviewees'''<br />
<br />
def reviewees<br />
reviewees = []<br />
rmaps = ResponseMap.all(conditions: ["reviewer_id = #{self.id} && type = 'ReviewResponseMap'"])<br />
rmaps.each { |rm| reviewees.concat(AssignmentTeam.find(rm.reviewee_id).participants) }<br />
<br />
reviewees<br />
end<br />
<br />
<br />
'''def two_node_cycles'''<br />
<br />
def two_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap|<br />
if ap.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap).nil? ? next : s01 = self.reviews_by_reviewer(ap).get_total_score<br />
ap.reviews_by_reviewer(self).nil? ? next : s10 = ap.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap, s10]])<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def three_node_cycles'''<br />
<br />
def three_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap1|<br />
ap1.reviewers.each do |ap2|<br />
if ap2.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap1).nil? ? next : s01 = self.reviews_by_reviewer(ap1).get_total_score<br />
ap1.reviews_by_reviewer(ap2).nil? ? next : s12 = ap1.reviews_by_reviewer(ap2).get_total_score<br />
ap2.reviews_by_reviewer(self).nil? ? next : s20 = ap2.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap1, s12], [ap2, s20]])<br />
end<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def four_node_cycles'''<br />
<br />
def four_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap1|<br />
ap1.reviewers.each do |ap2|<br />
ap2.reviewers.each do |ap3|<br />
if ap3.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap1).nil? ? next : s01 = self.reviews_by_reviewer(ap1).get_total_score<br />
ap1.reviews_by_reviewer(ap2).nil? ? next : s12 = ap1.reviews_by_reviewer(ap2).get_total_score<br />
ap2.reviews_by_reviewer(ap3).nil? ? next : s23 = ap2.reviews_by_reviewer(ap3).get_total_score<br />
ap3.reviews_by_reviewer(self).nil? ? next : s30 = ap3.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap1, s12], [ap2, s23], [ap3, s30]])<br />
end<br />
end<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def cycle_similarity_score(cycle)'''<br />
<br />
def cycle_similarity_score(cycle)<br />
similarity_score = 0.0<br />
count = 0.0<br />
<br />
0 ... cycle.size-1.each do |pivot|<br />
pivot_score = cycle[pivot][1]<br />
similarity_score = similarity_score + (pivot_score - cycle[other][1]).abs<br />
count = count + 1.0<br />
end<br />
<br />
similarity_score = similarity_score / count unless count == 0.0<br />
similarity_score<br />
end<br />
<br />
<br />
'''def cycle_deviation_score(cycle)'''<br />
<br />
def cycle_deviation_score(cycle)<br />
deviation_score = 0.0<br />
count = 0.0<br />
<br />
0 ... cycle.size.each do |member|<br />
participant = AssignmentParticipant.find(cycle[member][0].id)<br />
total_score = participant.get_review_score<br />
deviation_score = deviation_score + (total_score - cycle[member][1]).abs<br />
count = count + 1.0<br />
end<br />
<br />
deviation_score = deviation_score / count unless count == 0.0<br />
deviation_score<br />
end<br />
<br />
<br />
'''def compute_quiz_scores(scores)'''<br />
<br />
def compute_quiz_scores(scores)<br />
total = 0<br />
if scores[:quiz][:scores][:avg]<br />
return scores[:quiz][:scores][:avg] * 100 / 100.to_f<br />
else<br />
return 0<br />
end<br />
return total<br />
end<br />
<br />
<br />
'''def review_response_maps'''<br />
<br />
def review_response_maps<br />
participant = Participant.find(id)<br />
team_id = TeamsUser.team_id(participant.parent_id, participant.user_id)<br />
ReviewResponseMap.where(reviewee_id: team_id, reviewed_object_id: assignment.id)<br />
end<br />
<br />
<br />
'''def members'''<br />
<br />
def members<br />
team.try :participants<br />
end<br />
<br />
<br />
'''def get_hash(time_stamp)'''<br />
<br />
def get_hash(time_stamp)<br />
# first generate a hash from the assignment name itself<br />
hash_data = Digest::SHA1.digest(self.assignment.name.to_s)<br />
<br />
# second generate a hash from the first hash plus the user name and time stamp<br />
sign = hash_data + self.user.name.to_s + time_stamp.strftime("%Y-%m-%d %H:%M:%S")<br />
Digest::SHA1.digest(sign)<br />
end<br />
<br />
===Review methods===<br />
* The bookmark_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''BookmarkRatingQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def bookmark_reviews<br />
BookmarkRatingResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
BookmarkRatingResponseMap.get_assessments_for(participant) # participant.bookmark_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
* The teammate_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''TeammateReviewQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def teammate_reviews<br />
TeammateReviewResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
TeammateReviewResponseMap.get_assessments_for(participant) #participant.teammate_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109408CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-26T15:34:27Z<p>Cshao: /* Why refactoring? */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==1 Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==2 Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by_assignment_id_and_questionnaire_id(self.assignment.id, questionnaire.id).used_in_round<br />
#create symbol for "varying rubrics" feature -Yang<br />
if(round!=nil)<br />
questionnaire_symbol = (questionnaire.symbol.to_s+round.to_s).to_sym<br />
else<br />
questionnaire_symbol = questionnaire.symbol<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
if round==nil<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_for(self)<br />
else<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_round_for(self,round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
#merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = Hash.new<br />
scores[review_sym][:assessments] = Array.new<br />
scores[review_sym][:scores] = Hash.new<br />
scores[review_sym][:scores][:max] = -999999999<br />
scores[review_sym][:scores][:min] = 999999999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.get_review_rounds<br />
round_sym = ("review"+i.to_s).to_sym<br />
if scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].length==0<br />
next<br />
end<br />
length_of_assessments=scores[round_sym][:assessments].length.to_f<br />
<br />
scores[review_sym][:assessments]+=scores[round_sym][:assessments]<br />
<br />
if(scores[round_sym][:scores][:max]!=nil && scores[review_sym][:scores][:max]<scores[round_sym][:scores][:max])<br />
scores[review_sym][:scores][:max]= scores[round_sym][:scores][:max]<br />
end<br />
if(scores[round_sym][:scores][:min]!= nil && scores[review_sym][:scores][:min]>scores[round_sym][:scores][:min])<br />
scores[review_sym][:scores][:min]= scores[round_sym][:scores][:min]<br />
end<br />
if(scores[round_sym][:scores][:avg]!=nil)<br />
total_score += scores[round_sym][:scores][:avg]*length_of_assessments<br />
end<br />
end<br />
<br />
if scores[review_sym][:scores][:max] == -999999999 && scores[review_sym][:scores][:min] == 999999999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
<br />
scores[review_sym][:scores][:avg] = total_score/scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
if !topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
quiz_responses = Array.new<br />
quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
quiz_response_mappings.each do |qmapping|<br />
if (qmapping.response)<br />
quiz_responses << qmapping.response<br />
end<br />
end<br />
#scores[:quiz] = Hash.new<br />
#scores[:quiz][:assessments] = quiz_responses<br />
#scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
#scores[:total_score] += compute_quiz_scores(scores)<br />
<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
total_score = scores[:total_score]<br />
if total_score > 100<br />
total_score = 100<br />
end<br />
scores[:total_score] = total_score<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
<br />
assignment_questionnaires(questions, scores)<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
merge_scores(scores)<br />
<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
if !topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
quiz_responses = Array.new<br />
quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
quiz_response_mappings.each do |qmapping|<br />
if (qmapping.response)<br />
quiz_responses << qmapping.response<br />
end<br />
end<br />
#scores[:quiz] = Hash.new<br />
#scores[:quiz][:assessments] = quiz_responses<br />
#scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
#scores[:total_score] += compute_quiz_scores(scores)<br />
<br />
calculate_scores(scores)<br />
end<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by_assignment_id_and_questionnaire_id(self.assignment.id, questionnaire.id).used_in_round<br />
#create symbol for "varying rubrics" feature -Yang<br />
if(round!=nil)<br />
questionnaire_symbol = (questionnaire.symbol.to_s+round.to_s).to_sym<br />
else<br />
questionnaire_symbol = questionnaire.symbol<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
if round==nil<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_for(self)<br />
else<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_round_for(self,round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
#merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = Hash.new<br />
scores[review_sym][:assessments] = Array.new<br />
scores[review_sym][:scores] = Hash.new<br />
scores[review_sym][:scores][:max] = -999999999<br />
scores[review_sym][:scores][:min] = 999999999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.get_review_rounds<br />
round_sym = ("review"+i.to_s).to_sym<br />
if scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].length==0<br />
next<br />
end<br />
length_of_assessments=scores[round_sym][:assessments].length.to_f<br />
<br />
scores[review_sym][:assessments]+=scores[round_sym][:assessments]<br />
<br />
if(scores[round_sym][:scores][:max]!=nil && scores[review_sym][:scores][:max]<scores[round_sym][:scores][:max])<br />
scores[review_sym][:scores][:max]= scores[round_sym][:scores][:max]<br />
end<br />
if(scores[round_sym][:scores][:min]!= nil && scores[review_sym][:scores][:min]>scores[round_sym][:scores][:min])<br />
scores[review_sym][:scores][:min]= scores[round_sym][:scores][:min]<br />
end<br />
if(scores[round_sym][:scores][:avg]!=nil)<br />
total_score += scores[round_sym][:scores][:avg]*length_of_assessments<br />
end<br />
end<br />
<br />
if scores[review_sym][:scores][:max] == -999999999 && scores[review_sym][:scores][:min] == 999999999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
<br />
scores[review_sym][:scores][:avg] = total_score/scores[review_sym][:assessments].length.to_f<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def calculate_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
total_score = scores[:total_score]<br />
if total_score > 100<br />
total_score = 100<br />
end<br />
scores[:total_score] = total_score<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===set_handle method===<br />
The set_handle method had an unncessary ELSIF statement which was performing the same action '''self.handle = self.user.name'''. This has been clubbed as an OR condition to the IF statement and the first ELSIF statement has been removed.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def set_handle<br />
if self.user.handle == nil or self.user.handle == ""<br />
self.handle = self.user.name<br />
elsif AssignmentParticipant.where(parent_id: self.assignment.id, handle: self.user.handle).length > 0<br />
self.handle = self.user.name<br />
else<br />
self.handle = self.user.handle<br />
end<br />
self.save!<br />
end<br />
<br />
||def set_handle<br />
if self.user.handle == nil or self.user.handle == "" or AssignmentParticipant.where(parent_id: self.assignment.id, handle: self.user.handle).length > 0<br />
self.handle = self.user.name<br />
else<br />
self.handle = self.user.handle<br />
end<br />
self.save!<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===File and directory methods===<br />
The files and directory methods from AssignmentParticipant model have been moved to the '''FileHelper''' module.<br />
The methods '''files''', '''submitted_files''' and '''dir_path''' are appropriate for the '''FileHelper' module and hence been moved there.<br />
The below line was added to the AssignmentParticipant model.<br />
include FileHelper<br />
<br />
The AssignmentParticipant class would look like<br />
class AssignmentParticipant < Participant<br />
require 'wiki_helper'<br />
'''include FileHelper'''<br />
Methods moved to FileHelper:<br />
<br />
* submitted_files<br />
<br />
def submitted_files<br />
files(self.path) if self.directory_num<br />
end<br />
<br />
* files(directory)<br />
<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = Array.new<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each{|f| files << f}<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
* submitted_files()<br />
<br />
def submitted_files()<br />
files = Array.new<br />
if(self.directory_num)<br />
files = files(self.path)<br />
end<br />
return files<br />
end<br />
<br />
* dir_path<br />
<br />
def dir_path<br />
assignment.try :directory_path<br />
end<br />
<br />
===Remove unused methods===<br />
The following methods have been removed as they were not being used by the application.<br />
<br />
'''def average_score_per_assignment(assignment_id)'''<br />
<br />
def average_score_per_assignment(assignment_id)<br />
return 0 if self.response_maps.size == 0<br />
<br />
sum_of_scores = 0<br />
<br />
self.response_maps.metareview_response_maps.each do |metaresponse_map|<br />
if !metaresponse_map.response.empty? && response_map == assignment_id then<br />
sum_of_scores = sum_of_scores + response_map.response.last.average_score<br />
end<br />
end<br />
<br />
(sum_of_scores / self.response_maps.size).to_i<br />
end<br />
<br />
<br />
'''def quiz_taken_by?(contributor, reviewer)'''<br />
<br />
def quiz_taken_by?(contributor, reviewer)<br />
quiz_id = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
return QuizResponseMap.where(['reviewee_id = ? AND reviewer_id = ? AND reviewed_object_id = ?',<br />
self.id, reviewer.id, quiz_id]).count > 0<br />
end<br />
<br />
<br />
'''def has_quiz?'''<br />
<br />
def has_quiz?<br />
return !QuizQuestionnaire.find_by_instructor_id(self.id).nil?<br />
end<br />
<br />
<br />
'''def reviewees'''<br />
<br />
def reviewees<br />
reviewees = []<br />
rmaps = ResponseMap.all(conditions: ["reviewer_id = #{self.id} && type = 'ReviewResponseMap'"])<br />
rmaps.each { |rm| reviewees.concat(AssignmentTeam.find(rm.reviewee_id).participants) }<br />
<br />
reviewees<br />
end<br />
<br />
<br />
'''def two_node_cycles'''<br />
<br />
def two_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap|<br />
if ap.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap).nil? ? next : s01 = self.reviews_by_reviewer(ap).get_total_score<br />
ap.reviews_by_reviewer(self).nil? ? next : s10 = ap.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap, s10]])<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def three_node_cycles'''<br />
<br />
def three_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap1|<br />
ap1.reviewers.each do |ap2|<br />
if ap2.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap1).nil? ? next : s01 = self.reviews_by_reviewer(ap1).get_total_score<br />
ap1.reviews_by_reviewer(ap2).nil? ? next : s12 = ap1.reviews_by_reviewer(ap2).get_total_score<br />
ap2.reviews_by_reviewer(self).nil? ? next : s20 = ap2.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap1, s12], [ap2, s20]])<br />
end<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def four_node_cycles'''<br />
<br />
def four_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap1|<br />
ap1.reviewers.each do |ap2|<br />
ap2.reviewers.each do |ap3|<br />
if ap3.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap1).nil? ? next : s01 = self.reviews_by_reviewer(ap1).get_total_score<br />
ap1.reviews_by_reviewer(ap2).nil? ? next : s12 = ap1.reviews_by_reviewer(ap2).get_total_score<br />
ap2.reviews_by_reviewer(ap3).nil? ? next : s23 = ap2.reviews_by_reviewer(ap3).get_total_score<br />
ap3.reviews_by_reviewer(self).nil? ? next : s30 = ap3.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap1, s12], [ap2, s23], [ap3, s30]])<br />
end<br />
end<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def cycle_similarity_score(cycle)'''<br />
<br />
def cycle_similarity_score(cycle)<br />
similarity_score = 0.0<br />
count = 0.0<br />
<br />
0 ... cycle.size-1.each do |pivot|<br />
pivot_score = cycle[pivot][1]<br />
similarity_score = similarity_score + (pivot_score - cycle[other][1]).abs<br />
count = count + 1.0<br />
end<br />
<br />
similarity_score = similarity_score / count unless count == 0.0<br />
similarity_score<br />
end<br />
<br />
<br />
'''def cycle_deviation_score(cycle)'''<br />
<br />
def cycle_deviation_score(cycle)<br />
deviation_score = 0.0<br />
count = 0.0<br />
<br />
0 ... cycle.size.each do |member|<br />
participant = AssignmentParticipant.find(cycle[member][0].id)<br />
total_score = participant.get_review_score<br />
deviation_score = deviation_score + (total_score - cycle[member][1]).abs<br />
count = count + 1.0<br />
end<br />
<br />
deviation_score = deviation_score / count unless count == 0.0<br />
deviation_score<br />
end<br />
<br />
<br />
'''def compute_quiz_scores(scores)'''<br />
<br />
def compute_quiz_scores(scores)<br />
total = 0<br />
if scores[:quiz][:scores][:avg]<br />
return scores[:quiz][:scores][:avg] * 100 / 100.to_f<br />
else<br />
return 0<br />
end<br />
return total<br />
end<br />
<br />
<br />
'''def review_response_maps'''<br />
<br />
def review_response_maps<br />
participant = Participant.find(id)<br />
team_id = TeamsUser.team_id(participant.parent_id, participant.user_id)<br />
ReviewResponseMap.where(reviewee_id: team_id, reviewed_object_id: assignment.id)<br />
end<br />
<br />
<br />
'''def members'''<br />
<br />
def members<br />
team.try :participants<br />
end<br />
<br />
<br />
'''def get_hash(time_stamp)'''<br />
<br />
def get_hash(time_stamp)<br />
# first generate a hash from the assignment name itself<br />
hash_data = Digest::SHA1.digest(self.assignment.name.to_s)<br />
<br />
# second generate a hash from the first hash plus the user name and time stamp<br />
sign = hash_data + self.user.name.to_s + time_stamp.strftime("%Y-%m-%d %H:%M:%S")<br />
Digest::SHA1.digest(sign)<br />
end<br />
<br />
===Review methods===<br />
* The bookmark_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''BookmarkRatingQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def bookmark_reviews<br />
BookmarkRatingResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
BookmarkRatingResponseMap.get_assessments_for(participant) # participant.bookmark_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
* The teammate_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''TeammateReviewQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def teammate_reviews<br />
TeammateReviewResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
TeammateReviewResponseMap.get_assessments_for(participant) #participant.teammate_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109407CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-26T15:34:07Z<p>Cshao: /* Introduction to Expertiza */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==1 Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by_assignment_id_and_questionnaire_id(self.assignment.id, questionnaire.id).used_in_round<br />
#create symbol for "varying rubrics" feature -Yang<br />
if(round!=nil)<br />
questionnaire_symbol = (questionnaire.symbol.to_s+round.to_s).to_sym<br />
else<br />
questionnaire_symbol = questionnaire.symbol<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
if round==nil<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_for(self)<br />
else<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_round_for(self,round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
#merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = Hash.new<br />
scores[review_sym][:assessments] = Array.new<br />
scores[review_sym][:scores] = Hash.new<br />
scores[review_sym][:scores][:max] = -999999999<br />
scores[review_sym][:scores][:min] = 999999999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.get_review_rounds<br />
round_sym = ("review"+i.to_s).to_sym<br />
if scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].length==0<br />
next<br />
end<br />
length_of_assessments=scores[round_sym][:assessments].length.to_f<br />
<br />
scores[review_sym][:assessments]+=scores[round_sym][:assessments]<br />
<br />
if(scores[round_sym][:scores][:max]!=nil && scores[review_sym][:scores][:max]<scores[round_sym][:scores][:max])<br />
scores[review_sym][:scores][:max]= scores[round_sym][:scores][:max]<br />
end<br />
if(scores[round_sym][:scores][:min]!= nil && scores[review_sym][:scores][:min]>scores[round_sym][:scores][:min])<br />
scores[review_sym][:scores][:min]= scores[round_sym][:scores][:min]<br />
end<br />
if(scores[round_sym][:scores][:avg]!=nil)<br />
total_score += scores[round_sym][:scores][:avg]*length_of_assessments<br />
end<br />
end<br />
<br />
if scores[review_sym][:scores][:max] == -999999999 && scores[review_sym][:scores][:min] == 999999999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
<br />
scores[review_sym][:scores][:avg] = total_score/scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
if !topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
quiz_responses = Array.new<br />
quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
quiz_response_mappings.each do |qmapping|<br />
if (qmapping.response)<br />
quiz_responses << qmapping.response<br />
end<br />
end<br />
#scores[:quiz] = Hash.new<br />
#scores[:quiz][:assessments] = quiz_responses<br />
#scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
#scores[:total_score] += compute_quiz_scores(scores)<br />
<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
total_score = scores[:total_score]<br />
if total_score > 100<br />
total_score = 100<br />
end<br />
scores[:total_score] = total_score<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
<br />
assignment_questionnaires(questions, scores)<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
merge_scores(scores)<br />
<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
if !topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
quiz_responses = Array.new<br />
quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
quiz_response_mappings.each do |qmapping|<br />
if (qmapping.response)<br />
quiz_responses << qmapping.response<br />
end<br />
end<br />
#scores[:quiz] = Hash.new<br />
#scores[:quiz][:assessments] = quiz_responses<br />
#scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
#scores[:total_score] += compute_quiz_scores(scores)<br />
<br />
calculate_scores(scores)<br />
end<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by_assignment_id_and_questionnaire_id(self.assignment.id, questionnaire.id).used_in_round<br />
#create symbol for "varying rubrics" feature -Yang<br />
if(round!=nil)<br />
questionnaire_symbol = (questionnaire.symbol.to_s+round.to_s).to_sym<br />
else<br />
questionnaire_symbol = questionnaire.symbol<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
if round==nil<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_for(self)<br />
else<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_round_for(self,round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
#merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = Hash.new<br />
scores[review_sym][:assessments] = Array.new<br />
scores[review_sym][:scores] = Hash.new<br />
scores[review_sym][:scores][:max] = -999999999<br />
scores[review_sym][:scores][:min] = 999999999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.get_review_rounds<br />
round_sym = ("review"+i.to_s).to_sym<br />
if scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].length==0<br />
next<br />
end<br />
length_of_assessments=scores[round_sym][:assessments].length.to_f<br />
<br />
scores[review_sym][:assessments]+=scores[round_sym][:assessments]<br />
<br />
if(scores[round_sym][:scores][:max]!=nil && scores[review_sym][:scores][:max]<scores[round_sym][:scores][:max])<br />
scores[review_sym][:scores][:max]= scores[round_sym][:scores][:max]<br />
end<br />
if(scores[round_sym][:scores][:min]!= nil && scores[review_sym][:scores][:min]>scores[round_sym][:scores][:min])<br />
scores[review_sym][:scores][:min]= scores[round_sym][:scores][:min]<br />
end<br />
if(scores[round_sym][:scores][:avg]!=nil)<br />
total_score += scores[round_sym][:scores][:avg]*length_of_assessments<br />
end<br />
end<br />
<br />
if scores[review_sym][:scores][:max] == -999999999 && scores[review_sym][:scores][:min] == 999999999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
<br />
scores[review_sym][:scores][:avg] = total_score/scores[review_sym][:assessments].length.to_f<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def calculate_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
total_score = scores[:total_score]<br />
if total_score > 100<br />
total_score = 100<br />
end<br />
scores[:total_score] = total_score<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===set_handle method===<br />
The set_handle method had an unncessary ELSIF statement which was performing the same action '''self.handle = self.user.name'''. This has been clubbed as an OR condition to the IF statement and the first ELSIF statement has been removed.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def set_handle<br />
if self.user.handle == nil or self.user.handle == ""<br />
self.handle = self.user.name<br />
elsif AssignmentParticipant.where(parent_id: self.assignment.id, handle: self.user.handle).length > 0<br />
self.handle = self.user.name<br />
else<br />
self.handle = self.user.handle<br />
end<br />
self.save!<br />
end<br />
<br />
||def set_handle<br />
if self.user.handle == nil or self.user.handle == "" or AssignmentParticipant.where(parent_id: self.assignment.id, handle: self.user.handle).length > 0<br />
self.handle = self.user.name<br />
else<br />
self.handle = self.user.handle<br />
end<br />
self.save!<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===File and directory methods===<br />
The files and directory methods from AssignmentParticipant model have been moved to the '''FileHelper''' module.<br />
The methods '''files''', '''submitted_files''' and '''dir_path''' are appropriate for the '''FileHelper' module and hence been moved there.<br />
The below line was added to the AssignmentParticipant model.<br />
include FileHelper<br />
<br />
The AssignmentParticipant class would look like<br />
class AssignmentParticipant < Participant<br />
require 'wiki_helper'<br />
'''include FileHelper'''<br />
Methods moved to FileHelper:<br />
<br />
* submitted_files<br />
<br />
def submitted_files<br />
files(self.path) if self.directory_num<br />
end<br />
<br />
* files(directory)<br />
<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = Array.new<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each{|f| files << f}<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
* submitted_files()<br />
<br />
def submitted_files()<br />
files = Array.new<br />
if(self.directory_num)<br />
files = files(self.path)<br />
end<br />
return files<br />
end<br />
<br />
* dir_path<br />
<br />
def dir_path<br />
assignment.try :directory_path<br />
end<br />
<br />
===Remove unused methods===<br />
The following methods have been removed as they were not being used by the application.<br />
<br />
'''def average_score_per_assignment(assignment_id)'''<br />
<br />
def average_score_per_assignment(assignment_id)<br />
return 0 if self.response_maps.size == 0<br />
<br />
sum_of_scores = 0<br />
<br />
self.response_maps.metareview_response_maps.each do |metaresponse_map|<br />
if !metaresponse_map.response.empty? && response_map == assignment_id then<br />
sum_of_scores = sum_of_scores + response_map.response.last.average_score<br />
end<br />
end<br />
<br />
(sum_of_scores / self.response_maps.size).to_i<br />
end<br />
<br />
<br />
'''def quiz_taken_by?(contributor, reviewer)'''<br />
<br />
def quiz_taken_by?(contributor, reviewer)<br />
quiz_id = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
return QuizResponseMap.where(['reviewee_id = ? AND reviewer_id = ? AND reviewed_object_id = ?',<br />
self.id, reviewer.id, quiz_id]).count > 0<br />
end<br />
<br />
<br />
'''def has_quiz?'''<br />
<br />
def has_quiz?<br />
return !QuizQuestionnaire.find_by_instructor_id(self.id).nil?<br />
end<br />
<br />
<br />
'''def reviewees'''<br />
<br />
def reviewees<br />
reviewees = []<br />
rmaps = ResponseMap.all(conditions: ["reviewer_id = #{self.id} && type = 'ReviewResponseMap'"])<br />
rmaps.each { |rm| reviewees.concat(AssignmentTeam.find(rm.reviewee_id).participants) }<br />
<br />
reviewees<br />
end<br />
<br />
<br />
'''def two_node_cycles'''<br />
<br />
def two_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap|<br />
if ap.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap).nil? ? next : s01 = self.reviews_by_reviewer(ap).get_total_score<br />
ap.reviews_by_reviewer(self).nil? ? next : s10 = ap.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap, s10]])<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def three_node_cycles'''<br />
<br />
def three_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap1|<br />
ap1.reviewers.each do |ap2|<br />
if ap2.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap1).nil? ? next : s01 = self.reviews_by_reviewer(ap1).get_total_score<br />
ap1.reviews_by_reviewer(ap2).nil? ? next : s12 = ap1.reviews_by_reviewer(ap2).get_total_score<br />
ap2.reviews_by_reviewer(self).nil? ? next : s20 = ap2.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap1, s12], [ap2, s20]])<br />
end<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def four_node_cycles'''<br />
<br />
def four_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap1|<br />
ap1.reviewers.each do |ap2|<br />
ap2.reviewers.each do |ap3|<br />
if ap3.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap1).nil? ? next : s01 = self.reviews_by_reviewer(ap1).get_total_score<br />
ap1.reviews_by_reviewer(ap2).nil? ? next : s12 = ap1.reviews_by_reviewer(ap2).get_total_score<br />
ap2.reviews_by_reviewer(ap3).nil? ? next : s23 = ap2.reviews_by_reviewer(ap3).get_total_score<br />
ap3.reviews_by_reviewer(self).nil? ? next : s30 = ap3.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap1, s12], [ap2, s23], [ap3, s30]])<br />
end<br />
end<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def cycle_similarity_score(cycle)'''<br />
<br />
def cycle_similarity_score(cycle)<br />
similarity_score = 0.0<br />
count = 0.0<br />
<br />
0 ... cycle.size-1.each do |pivot|<br />
pivot_score = cycle[pivot][1]<br />
similarity_score = similarity_score + (pivot_score - cycle[other][1]).abs<br />
count = count + 1.0<br />
end<br />
<br />
similarity_score = similarity_score / count unless count == 0.0<br />
similarity_score<br />
end<br />
<br />
<br />
'''def cycle_deviation_score(cycle)'''<br />
<br />
def cycle_deviation_score(cycle)<br />
deviation_score = 0.0<br />
count = 0.0<br />
<br />
0 ... cycle.size.each do |member|<br />
participant = AssignmentParticipant.find(cycle[member][0].id)<br />
total_score = participant.get_review_score<br />
deviation_score = deviation_score + (total_score - cycle[member][1]).abs<br />
count = count + 1.0<br />
end<br />
<br />
deviation_score = deviation_score / count unless count == 0.0<br />
deviation_score<br />
end<br />
<br />
<br />
'''def compute_quiz_scores(scores)'''<br />
<br />
def compute_quiz_scores(scores)<br />
total = 0<br />
if scores[:quiz][:scores][:avg]<br />
return scores[:quiz][:scores][:avg] * 100 / 100.to_f<br />
else<br />
return 0<br />
end<br />
return total<br />
end<br />
<br />
<br />
'''def review_response_maps'''<br />
<br />
def review_response_maps<br />
participant = Participant.find(id)<br />
team_id = TeamsUser.team_id(participant.parent_id, participant.user_id)<br />
ReviewResponseMap.where(reviewee_id: team_id, reviewed_object_id: assignment.id)<br />
end<br />
<br />
<br />
'''def members'''<br />
<br />
def members<br />
team.try :participants<br />
end<br />
<br />
<br />
'''def get_hash(time_stamp)'''<br />
<br />
def get_hash(time_stamp)<br />
# first generate a hash from the assignment name itself<br />
hash_data = Digest::SHA1.digest(self.assignment.name.to_s)<br />
<br />
# second generate a hash from the first hash plus the user name and time stamp<br />
sign = hash_data + self.user.name.to_s + time_stamp.strftime("%Y-%m-%d %H:%M:%S")<br />
Digest::SHA1.digest(sign)<br />
end<br />
<br />
===Review methods===<br />
* The bookmark_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''BookmarkRatingQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def bookmark_reviews<br />
BookmarkRatingResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
BookmarkRatingResponseMap.get_assessments_for(participant) # participant.bookmark_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
* The teammate_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''TeammateReviewQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def teammate_reviews<br />
TeammateReviewResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
TeammateReviewResponseMap.get_assessments_for(participant) #participant.teammate_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshaohttps://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2017/E1770_Refactor_assignment_participant.rb&diff=109406CSC/ECE 517 Fall 2017/E1770 Refactor assignment participant.rb2017-10-26T15:32:56Z<p>Cshao: /* Why Test-driven development? */</p>
<hr />
<div>'''E1770. [Test First Development] Refactor assignment_participant.rb'''<ref>Project Description document https://docs.google.com/document/d/1rdolBAHxVGI9I0N-cT866AqnfORM2L1_m_bo2gRYRrI/edit#heading=h.s18ldps2kz5e</ref><br />
<br />
This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring the AssignmentParticipant model which is subclass of Participant model. This model is used to maintain the list of students/users participating in a given assignment. For any new or existing assignments, this model manages the entire list of users assigned to that particular assignment. It primarily includes method for scores calculations, assignment submission paths, reviews, etc. As part of this project, some of the methods have been removed which were not being used anywhere, some have been moved to their appropriate helper module and some have been refactored into smaller ones.<br />
<br />
==Introduction to Expertiza==<br />
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments. <br />
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.<br />
<br />
==Why refactoring?==<br />
'''Code Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is the process of restructuring existing computer code—changing the factoring—without changing its external behavior. <br />
<br />
Refactoring improves nonfunctional attributes of the software. Advantages include improved code readability and reduced complexity; these can improve source-code maintainability and create a more expressive internal architecture or object model to improve extensibility. Typically, refactoring applies a series of standardised basic micro-refactorings, each of which is (usually) a tiny change in a computer program's source code that either preserves the behaviour of the software, or at least does not modify its conformance to functional requirements. Many development environments provide automated support for performing the mechanical aspects of these basic refactorings. If done extremely well, code refactoring may also resolve hidden, dormant, or undiscovered bugs or vulnerabilities in the system by simplifying the underlying logic and eliminating unnecessary levels of complexity. If done poorly it may fail the requirement that external functionality not be changed, introduce new bugs, or both.<br />
<br />
==Why Test-driven development?==<br />
'''Test-driven development (TDD)'''<ref>Test-driven development (TDD) https://en.wikipedia.org/wiki/Test-driven_development</ref> is a software development process that relies on the repetition of a very short development cycle: Requirements are turned into very specific test cases, then the software is improved to pass the new tests, only. This is opposed to software development that allows software to be added that is not proven to meet requirements. The followings are several benefits of Test-driven development (TDD).<br />
<br />
* Maintainable, Flexible, Easily Extensible.<br />
* Unparalleled Test Coverage & Streamlined Codebase.<br />
* Clean Interface.<br />
* Refactoring Encourages Improvements.<br />
* Executable Documentation.<br />
<br />
==Introduction to RSpec==<br />
'''RSpec'''<ref>RSpec https://en.wikipedia.org/wiki/RSpec</ref> is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring. It contains its own mocking framework that is fully integrated into the framework based upon JMock. The simplicity in the RSpec syntax makes it one of the popular testing tools for Ruby applications. The RSpec tool can be used by installing the rspec gem which consists of 3 other gems namely rspec-core , rspec-expectation and rspec-mock.<br />
<br />
== Project Description ==<br />
Refactor '''AssignmentParticipant''' model which is a subclass of '''Participant''' model.<br />
The following tasks have been performed as per the requirements.<br />
<br />
* Refactor scores method.<br />
** Write failing tests first.<br />
** Split into several simpler methods and assign reasonable names.<br />
** Extract duplicated code into separate methods.<br />
** Replace the conditional with the relevant method calls.<br />
<br />
* Method files is exactly the same as assignment_team.rb L103.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Method self.import is exact the same as course_participant.rb L21.<br />
** Write failing tests first.<br />
** Solve the duplication, extract method to a new file or delete useless one.<br />
<br />
* Use find_by instead of dynamic method.<br />
** Write failing tests first.<br />
<br />
* Use find_by instead of where.first.<br />
** Write failing tests first.<br />
<br />
== Refactoring ==<br />
===Scores method===<br />
The method '''scores''' has been converted to smaller methods '''scores''', '''assignment_questionnaires''', '''merge_scores''', '''calculate_scores'''. It is a good practice to keep the methods not extremely long as they tend to complicate the functionality and the readability.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by_assignment_id_and_questionnaire_id(self.assignment.id, questionnaire.id).used_in_round<br />
#create symbol for "varying rubrics" feature -Yang<br />
if(round!=nil)<br />
questionnaire_symbol = (questionnaire.symbol.to_s+round.to_s).to_sym<br />
else<br />
questionnaire_symbol = questionnaire.symbol<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
if round==nil<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_for(self)<br />
else<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_round_for(self,round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
#merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = Hash.new<br />
scores[review_sym][:assessments] = Array.new<br />
scores[review_sym][:scores] = Hash.new<br />
scores[review_sym][:scores][:max] = -999999999<br />
scores[review_sym][:scores][:min] = 999999999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.get_review_rounds<br />
round_sym = ("review"+i.to_s).to_sym<br />
if scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].length==0<br />
next<br />
end<br />
length_of_assessments=scores[round_sym][:assessments].length.to_f<br />
<br />
scores[review_sym][:assessments]+=scores[round_sym][:assessments]<br />
<br />
if(scores[round_sym][:scores][:max]!=nil && scores[review_sym][:scores][:max]<scores[round_sym][:scores][:max])<br />
scores[review_sym][:scores][:max]= scores[round_sym][:scores][:max]<br />
end<br />
if(scores[round_sym][:scores][:min]!= nil && scores[review_sym][:scores][:min]>scores[round_sym][:scores][:min])<br />
scores[review_sym][:scores][:min]= scores[round_sym][:scores][:min]<br />
end<br />
if(scores[round_sym][:scores][:avg]!=nil)<br />
total_score += scores[round_sym][:scores][:avg]*length_of_assessments<br />
end<br />
end<br />
<br />
if scores[review_sym][:scores][:max] == -999999999 && scores[review_sym][:scores][:min] == 999999999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
<br />
scores[review_sym][:scores][:avg] = total_score/scores[review_sym][:assessments].length.to_f<br />
end<br />
<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
if !topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
quiz_responses = Array.new<br />
quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
quiz_response_mappings.each do |qmapping|<br />
if (qmapping.response)<br />
quiz_responses << qmapping.response<br />
end<br />
end<br />
#scores[:quiz] = Hash.new<br />
#scores[:quiz][:assessments] = quiz_responses<br />
#scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
#scores[:total_score] += compute_quiz_scores(scores)<br />
<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
total_score = scores[:total_score]<br />
if total_score > 100<br />
total_score = 100<br />
end<br />
scores[:total_score] = total_score<br />
scores<br />
end<br />
end<br />
||<br />
* scores(questions) method<br />
<br />
def scores(questions)<br />
scores = {}<br />
scores[:participant] = self<br />
<br />
assignment_questionnaires(questions, scores)<br />
<br />
scores[:total_score] = self.assignment.compute_total_score(scores)<br />
<br />
merge_scores(scores)<br />
<br />
# In the event that this is a microtask, we need to scale the score accordingly and record the total possible points<br />
# PS: I don't like the fact that we are doing this here but it is difficult to make it work anywhere else<br />
if assignment.is_microtask?<br />
topic = SignUpTopic.find_by_assignment_id(assignment.id)<br />
if !topic.nil?<br />
scores[:total_score] *= (topic.micropayment.to_f / 100.to_f)<br />
scores[:max_pts_available] = topic.micropayment<br />
end<br />
end<br />
<br />
# for all quiz questionnaires (quizzes) taken by the participant<br />
quiz_responses = Array.new<br />
quiz_response_mappings = QuizResponseMap.where(reviewer_id: self.id)<br />
quiz_response_mappings.each do |qmapping|<br />
if (qmapping.response)<br />
quiz_responses << qmapping.response<br />
end<br />
end<br />
#scores[:quiz] = Hash.new<br />
#scores[:quiz][:assessments] = quiz_responses<br />
#scores[:quiz][:scores] = Answer.compute_quiz_scores(scores[:quiz][:assessments])<br />
<br />
scores[:total_score] = assignment.compute_total_score(scores)<br />
#scores[:total_score] += compute_quiz_scores(scores)<br />
<br />
calculate_scores(scores)<br />
end<br />
* assignment_questionnaires(questions, scores) method<br />
<br />
def assignment_questionnaires(questions, scores)<br />
self.assignment.questionnaires.each do |questionnaire|<br />
round = AssignmentQuestionnaire.find_by_assignment_id_and_questionnaire_id(self.assignment.id, questionnaire.id).used_in_round<br />
#create symbol for "varying rubrics" feature -Yang<br />
if(round!=nil)<br />
questionnaire_symbol = (questionnaire.symbol.to_s+round.to_s).to_sym<br />
else<br />
questionnaire_symbol = questionnaire.symbol<br />
end<br />
<br />
scores[questionnaire_symbol] = {}<br />
<br />
if round==nil<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_for(self)<br />
else<br />
scores[questionnaire_symbol][:assessments] = questionnaire.get_assessments_round_for(self,round)<br />
end<br />
scores[questionnaire_symbol][:scores] = Answer.compute_scores(scores[questionnaire_symbol][:assessments], questions[questionnaire_symbol])<br />
end<br />
end<br />
<br />
* merge_scores(scores) method<br />
<br />
def merge_scores(scores)<br />
#merge scores[review#] (for each round) to score[review] -Yang<br />
if self.assignment.varying_rubrics_by_round?<br />
review_sym = "review".to_sym<br />
scores[review_sym] = Hash.new<br />
scores[review_sym][:assessments] = Array.new<br />
scores[review_sym][:scores] = Hash.new<br />
scores[review_sym][:scores][:max] = -999999999<br />
scores[review_sym][:scores][:min] = 999999999<br />
scores[review_sym][:scores][:avg] = 0<br />
total_score = 0<br />
for i in 1..self.assignment.get_review_rounds<br />
round_sym = ("review"+i.to_s).to_sym<br />
if scores[round_sym][:assessments].nil? || scores[round_sym][:assessments].length==0<br />
next<br />
end<br />
length_of_assessments=scores[round_sym][:assessments].length.to_f<br />
<br />
scores[review_sym][:assessments]+=scores[round_sym][:assessments]<br />
<br />
if(scores[round_sym][:scores][:max]!=nil && scores[review_sym][:scores][:max]<scores[round_sym][:scores][:max])<br />
scores[review_sym][:scores][:max]= scores[round_sym][:scores][:max]<br />
end<br />
if(scores[round_sym][:scores][:min]!= nil && scores[review_sym][:scores][:min]>scores[round_sym][:scores][:min])<br />
scores[review_sym][:scores][:min]= scores[round_sym][:scores][:min]<br />
end<br />
if(scores[round_sym][:scores][:avg]!=nil)<br />
total_score += scores[round_sym][:scores][:avg]*length_of_assessments<br />
end<br />
end<br />
<br />
if scores[review_sym][:scores][:max] == -999999999 && scores[review_sym][:scores][:min] == 999999999<br />
scores[review_sym][:scores][:max] = 0<br />
scores[review_sym][:scores][:min] = 0<br />
end<br />
<br />
scores[review_sym][:scores][:avg] = total_score/scores[review_sym][:assessments].length.to_f<br />
end<br />
end<br />
<br />
* calculate_scores(scores) method<br />
<br />
def calculate_scores(scores)<br />
# move lots of calculation from view(_participant.html.erb) to model<br />
if self.grade<br />
scores[:total_score] = self.grade<br />
else<br />
total_score = scores[:total_score]<br />
if total_score > 100<br />
total_score = 100<br />
end<br />
scores[:total_score] = total_score<br />
scores<br />
end<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===set_handle method===<br />
The set_handle method had an unncessary ELSIF statement which was performing the same action '''self.handle = self.user.name'''. This has been clubbed as an OR condition to the IF statement and the first ELSIF statement has been removed.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def set_handle<br />
if self.user.handle == nil or self.user.handle == ""<br />
self.handle = self.user.name<br />
elsif AssignmentParticipant.where(parent_id: self.assignment.id, handle: self.user.handle).length > 0<br />
self.handle = self.user.name<br />
else<br />
self.handle = self.user.handle<br />
end<br />
self.save!<br />
end<br />
<br />
||def set_handle<br />
if self.user.handle == nil or self.user.handle == "" or AssignmentParticipant.where(parent_id: self.assignment.id, handle: self.user.handle).length > 0<br />
self.handle = self.user.name<br />
else<br />
self.handle = self.user.handle<br />
end<br />
self.save!<br />
end<br />
<br />
|-<br />
|}<br />
<br />
===File and directory methods===<br />
The files and directory methods from AssignmentParticipant model have been moved to the '''FileHelper''' module.<br />
The methods '''files''', '''submitted_files''' and '''dir_path''' are appropriate for the '''FileHelper' module and hence been moved there.<br />
The below line was added to the AssignmentParticipant model.<br />
include FileHelper<br />
<br />
The AssignmentParticipant class would look like<br />
class AssignmentParticipant < Participant<br />
require 'wiki_helper'<br />
'''include FileHelper'''<br />
Methods moved to FileHelper:<br />
<br />
* submitted_files<br />
<br />
def submitted_files<br />
files(self.path) if self.directory_num<br />
end<br />
<br />
* files(directory)<br />
<br />
def files(directory)<br />
files_list = Dir[directory + "/*"]<br />
files = Array.new<br />
<br />
files_list.each do |file|<br />
if File.directory?(file)<br />
dir_files = files(file)<br />
dir_files.each{|f| files << f}<br />
end<br />
files << file<br />
end<br />
files<br />
end<br />
<br />
* submitted_files()<br />
<br />
def submitted_files()<br />
files = Array.new<br />
if(self.directory_num)<br />
files = files(self.path)<br />
end<br />
return files<br />
end<br />
<br />
* dir_path<br />
<br />
def dir_path<br />
assignment.try :directory_path<br />
end<br />
<br />
===Remove unused methods===<br />
The following methods have been removed as they were not being used by the application.<br />
<br />
'''def average_score_per_assignment(assignment_id)'''<br />
<br />
def average_score_per_assignment(assignment_id)<br />
return 0 if self.response_maps.size == 0<br />
<br />
sum_of_scores = 0<br />
<br />
self.response_maps.metareview_response_maps.each do |metaresponse_map|<br />
if !metaresponse_map.response.empty? && response_map == assignment_id then<br />
sum_of_scores = sum_of_scores + response_map.response.last.average_score<br />
end<br />
end<br />
<br />
(sum_of_scores / self.response_maps.size).to_i<br />
end<br />
<br />
<br />
'''def quiz_taken_by?(contributor, reviewer)'''<br />
<br />
def quiz_taken_by?(contributor, reviewer)<br />
quiz_id = QuizQuestionnaire.find_by_instructor_id(contributor.id)<br />
return QuizResponseMap.where(['reviewee_id = ? AND reviewer_id = ? AND reviewed_object_id = ?',<br />
self.id, reviewer.id, quiz_id]).count > 0<br />
end<br />
<br />
<br />
'''def has_quiz?'''<br />
<br />
def has_quiz?<br />
return !QuizQuestionnaire.find_by_instructor_id(self.id).nil?<br />
end<br />
<br />
<br />
'''def reviewees'''<br />
<br />
def reviewees<br />
reviewees = []<br />
rmaps = ResponseMap.all(conditions: ["reviewer_id = #{self.id} && type = 'ReviewResponseMap'"])<br />
rmaps.each { |rm| reviewees.concat(AssignmentTeam.find(rm.reviewee_id).participants) }<br />
<br />
reviewees<br />
end<br />
<br />
<br />
'''def two_node_cycles'''<br />
<br />
def two_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap|<br />
if ap.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap).nil? ? next : s01 = self.reviews_by_reviewer(ap).get_total_score<br />
ap.reviews_by_reviewer(self).nil? ? next : s10 = ap.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap, s10]])<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def three_node_cycles'''<br />
<br />
def three_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap1|<br />
ap1.reviewers.each do |ap2|<br />
if ap2.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap1).nil? ? next : s01 = self.reviews_by_reviewer(ap1).get_total_score<br />
ap1.reviews_by_reviewer(ap2).nil? ? next : s12 = ap1.reviews_by_reviewer(ap2).get_total_score<br />
ap2.reviews_by_reviewer(self).nil? ? next : s20 = ap2.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap1, s12], [ap2, s20]])<br />
end<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def four_node_cycles'''<br />
<br />
def four_node_cycles<br />
cycles = []<br />
self.reviewers.each do |ap1|<br />
ap1.reviewers.each do |ap2|<br />
ap2.reviewers.each do |ap3|<br />
if ap3.reviewers.include?(self)<br />
self.reviews_by_reviewer(ap1).nil? ? next : s01 = self.reviews_by_reviewer(ap1).get_total_score<br />
ap1.reviews_by_reviewer(ap2).nil? ? next : s12 = ap1.reviews_by_reviewer(ap2).get_total_score<br />
ap2.reviews_by_reviewer(ap3).nil? ? next : s23 = ap2.reviews_by_reviewer(ap3).get_total_score<br />
ap3.reviews_by_reviewer(self).nil? ? next : s30 = ap3.reviews_by_reviewer(self).get_total_score<br />
cycles.push([[self, s01], [ap1, s12], [ap2, s23], [ap3, s30]])<br />
end<br />
end<br />
end<br />
end<br />
cycles<br />
end<br />
<br />
<br />
'''def cycle_similarity_score(cycle)'''<br />
<br />
def cycle_similarity_score(cycle)<br />
similarity_score = 0.0<br />
count = 0.0<br />
<br />
0 ... cycle.size-1.each do |pivot|<br />
pivot_score = cycle[pivot][1]<br />
similarity_score = similarity_score + (pivot_score - cycle[other][1]).abs<br />
count = count + 1.0<br />
end<br />
<br />
similarity_score = similarity_score / count unless count == 0.0<br />
similarity_score<br />
end<br />
<br />
<br />
'''def cycle_deviation_score(cycle)'''<br />
<br />
def cycle_deviation_score(cycle)<br />
deviation_score = 0.0<br />
count = 0.0<br />
<br />
0 ... cycle.size.each do |member|<br />
participant = AssignmentParticipant.find(cycle[member][0].id)<br />
total_score = participant.get_review_score<br />
deviation_score = deviation_score + (total_score - cycle[member][1]).abs<br />
count = count + 1.0<br />
end<br />
<br />
deviation_score = deviation_score / count unless count == 0.0<br />
deviation_score<br />
end<br />
<br />
<br />
'''def compute_quiz_scores(scores)'''<br />
<br />
def compute_quiz_scores(scores)<br />
total = 0<br />
if scores[:quiz][:scores][:avg]<br />
return scores[:quiz][:scores][:avg] * 100 / 100.to_f<br />
else<br />
return 0<br />
end<br />
return total<br />
end<br />
<br />
<br />
'''def review_response_maps'''<br />
<br />
def review_response_maps<br />
participant = Participant.find(id)<br />
team_id = TeamsUser.team_id(participant.parent_id, participant.user_id)<br />
ReviewResponseMap.where(reviewee_id: team_id, reviewed_object_id: assignment.id)<br />
end<br />
<br />
<br />
'''def members'''<br />
<br />
def members<br />
team.try :participants<br />
end<br />
<br />
<br />
'''def get_hash(time_stamp)'''<br />
<br />
def get_hash(time_stamp)<br />
# first generate a hash from the assignment name itself<br />
hash_data = Digest::SHA1.digest(self.assignment.name.to_s)<br />
<br />
# second generate a hash from the first hash plus the user name and time stamp<br />
sign = hash_data + self.user.name.to_s + time_stamp.strftime("%Y-%m-%d %H:%M:%S")<br />
Digest::SHA1.digest(sign)<br />
end<br />
<br />
===Review methods===<br />
* The bookmark_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''BookmarkRatingQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def bookmark_reviews<br />
BookmarkRatingResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
BookmarkRatingResponseMap.get_assessments_for(participant) # participant.bookmark_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
* The teammate_reviews() method from AssignmentParticipant was being called once in '''get_assessments_for''' method of '''TeammateReviewQuestionnaire''' class. It has been replaced by the method statement directly since it only had a single line of code.<br />
<br />
{| class = "wikitable"<br />
|-<br />
!Before!!After<br />
|-<br />
|def teammate_reviews<br />
TeammateReviewResponseMap.get_assessments_for(self)<br />
end<br />
<br />
||def get_assessments_for(participant)<br />
TeammateReviewResponseMap.get_assessments_for(participant) #participant.teammate_reviews()<br />
end<br />
<br />
|-<br />
|}<br />
<br />
==Resources==<br />
* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref><br />
* Our Github repository<ref>Our Github Repository https://github.com/terryliu1995/expertiza</ref><br />
<br />
== References ==<br />
<references/></div>Cshao