https://wiki.expertiza.ncsu.edu/api.php?action=feedcontributions&feedformat=atom&user=Ggarima 2026-07-02T10:26:19Z User contributions MediaWiki 1.41.0 https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-E1974_Allow_users_to_create_an_account_and_submit_work_to_an_%E2%80%9Dassignment%E2%80%9D_Design&diff=129869 2019-12-06T00:16:32Z

<p>Ggarima: /* Files to be changed */</p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==Problem Statement==<br /> <br /> ===Existing Solution===<br /> Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.<br /> <br /> ===Proposed Solution===<br /> This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.<br /> The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.<br /> <br /> ==Task to be Accomplished==<br /> * When creating a conference type assignment, a link to join the conference will be show on the assignment page.<br /> * Instructor will share the joining link with Author and they should be able to create account using that link, if account already does not exist.<br /> * Author will be able to create a new team in &quot;Your Team&quot; section and can invite other Co-Authors to join the team.<br /> * If Co-Authors already exists in expertiza, they will be able to see invite on their homepage and if they do not exist in expertiza they will receive an email with joining link on email id used by Author while inviting them.<br /> * Once Co-Author sees the invite they can accept or reject it.<br /> <br /> ==Sequence Diagram==<br /> [[File:OSS12.png]]<br /> <br /> ==Design - The Grubby Details==<br /> <br /> ===Creating The conference type assignment===<br /> <br /> Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:<br /> <br /> 1. Instructor logs in with his credentials.<br /> <br /> 2. Instructor creates an assignment by checking a new check box - “Will this be a conference type of assignment”, to mark the assignment to be of conference type.<br /> <br /> * This checkbox will be introduced in the Assignment’s edit page ('''app/views/assignments/edit/_general.html''')<br /> <br /> 3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.<br /> <br /> * Author of the assignment will use this URL to create the team and do conference paper submission. If author does not have account already in expertiza, Author will be asked to create account.<br /> <br /> The usage of the url and working will be discussed in the next part.<br /> <br /> ===Changes for Conference's authors===<br /> <br /> Following will be the high level steps the Author would be performing to create an account:<br /> <br /> 1. Once instructor shares the joining link with potential Authors, they can use their existing expertiza accounts or create new accounts for making a team and add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.<br /> <br /> 2. When Author clicks on joining link, there could be two cases that author have expertiza account or author does not have expertiza account. <br /> <br /> *If Author already has an account he will be able to view the assignment assigned to him and a default team.<br /> *If Author does not have expertiza account, he/she will be asked to put some details to create account with role as student. After account creation, Author will receive email with login ID and password. <br /> <br /> 3. After Author logs in, he/she can navigate to '''assignment -&gt; Your Team''' and invite co-authors into his team for working on the submission.<br /> <br /> 4. When inviting the Co-Authors, Author can give Expertiza user name of Co-Author if they already exists in expertiza or Author can invite them by giving email id of Co-Author. <br /> <br /> 5. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).<br /> <br /> ===Changes for Conference's co-authors===<br /> <br /> 1. If Co-Author expertiza account already exists, when Co-Author logs in expertiza, he or she will be able to see conference assignment in homepage and team invite in &quot;Your Team&quot; section.<br /> <br /> 2. If Co-Author does not exists then he/she will receive an email with login id and password and Expertiza web address on the email id, that was used by author to invite them. When Co-Author logs in with same email id or password, he/she will be able to see conference assignment in homepage and team invite in &quot;Your Team&quot; section.<br /> <br /> 3. After that Co-Author can accept or reject the team invite and proceed with assignment submission. <br /> <br /> 4. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.<br /> <br /> ===Database Changes===<br /> As part of this project, the change in the database would be addition of a new column: 'is_conference' in 'Assignment' table with default value 0, and value = 1 if the assignment is 'conference' type.<br /> <br /> ===Files to be changed===<br /> [[Image:Design_g.png]]<br /> <br /> ==Test Plan==<br /> <br /> Please find the below plan to test the functionality<br /> <br /> === RSpec Tests ===<br /> Please find below RSpec Test cases for this feature<br /> <br /> ====Scenario 1: Creating student type user from controller by bypassing admin approval ====<br /> After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if author is able to to create and login into a new account without admin approval<br /> <br /> ====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====<br /> After Author has created an account, he/she should be able to access the conference type account.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author is assigned to conference type assignment and able to access it<br /> *Test case to check if Co-author is assigned to conference type assignment and able to access it<br /> *Test case to check if Author has been added to default team<br /> *Test case to check if Co-author is added to Author's team<br /> <br /> ====Scenario 3: Conference type assignment being created ====<br /> Instructor should be able to create conference type assignment<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Conference type assignment has been created<br /> <br /> ====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====<br /> After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author/Co-author already have an account<br /> *Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account<br /> <br /> ==Teammates==<br /> <br /> Mentor - Prof. Edward Gehringer<br /> <br /> * Sameer Adhikari (sadhika2)<br /> * Gurman Singh (gsingh23)<br /> * Garima Garima (ggarima)<br /> * Bharat Bhardwaj (bbhardw)<br /> <br /> ==References==<br /> # [https://github.com/expertiza/expertiza Github Repository for Expertiza]<br /> # [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]<br /> # [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=File:Design_g.png&diff=129868 2019-12-06T00:16:23Z

<p>Ggarima: </p> <hr /> <div></div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=File:Design_pic.png&diff=129867 2019-12-06T00:15:31Z

<p>Ggarima: uploaded a new version of &amp;quot;File:Design pic.png&amp;quot;</p> <hr /> <div></div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-E1974_Allow_users_to_create_an_account_and_submit_work_to_an_%E2%80%9Dassignment%E2%80%9D_Design&diff=129866 2019-12-06T00:13:48Z

<p>Ggarima: /* Database Changes */</p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==Problem Statement==<br /> <br /> ===Existing Solution===<br /> Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.<br /> <br /> ===Proposed Solution===<br /> This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.<br /> The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.<br /> <br /> ==Task to be Accomplished==<br /> * When creating a conference type assignment, a link to join the conference will be show on the assignment page.<br /> * Instructor will share the joining link with Author and they should be able to create account using that link, if account already does not exist.<br /> * Author will be able to create a new team in &quot;Your Team&quot; section and can invite other Co-Authors to join the team.<br /> * If Co-Authors already exists in expertiza, they will be able to see invite on their homepage and if they do not exist in expertiza they will receive an email with joining link on email id used by Author while inviting them.<br /> * Once Co-Author sees the invite they can accept or reject it.<br /> <br /> ==Sequence Diagram==<br /> [[File:OSS12.png]]<br /> <br /> ==Design - The Grubby Details==<br /> <br /> ===Creating The conference type assignment===<br /> <br /> Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:<br /> <br /> 1. Instructor logs in with his credentials.<br /> <br /> 2. Instructor creates an assignment by checking a new check box - “Will this be a conference type of assignment”, to mark the assignment to be of conference type.<br /> <br /> * This checkbox will be introduced in the Assignment’s edit page ('''app/views/assignments/edit/_general.html''')<br /> <br /> 3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.<br /> <br /> * Author of the assignment will use this URL to create the team and do conference paper submission. If author does not have account already in expertiza, Author will be asked to create account.<br /> <br /> The usage of the url and working will be discussed in the next part.<br /> <br /> ===Changes for Conference's authors===<br /> <br /> Following will be the high level steps the Author would be performing to create an account:<br /> <br /> 1. Once instructor shares the joining link with potential Authors, they can use their existing expertiza accounts or create new accounts for making a team and add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.<br /> <br /> 2. When Author clicks on joining link, there could be two cases that author have expertiza account or author does not have expertiza account. <br /> <br /> *If Author already has an account he will be able to view the assignment assigned to him and a default team.<br /> *If Author does not have expertiza account, he/she will be asked to put some details to create account with role as student. After account creation, Author will receive email with login ID and password. <br /> <br /> 3. After Author logs in, he/she can navigate to '''assignment -&gt; Your Team''' and invite co-authors into his team for working on the submission.<br /> <br /> 4. When inviting the Co-Authors, Author can give Expertiza user name of Co-Author if they already exists in expertiza or Author can invite them by giving email id of Co-Author. <br /> <br /> 5. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).<br /> <br /> ===Changes for Conference's co-authors===<br /> <br /> 1. If Co-Author expertiza account already exists, when Co-Author logs in expertiza, he or she will be able to see conference assignment in homepage and team invite in &quot;Your Team&quot; section.<br /> <br /> 2. If Co-Author does not exists then he/she will receive an email with login id and password and Expertiza web address on the email id, that was used by author to invite them. When Co-Author logs in with same email id or password, he/she will be able to see conference assignment in homepage and team invite in &quot;Your Team&quot; section.<br /> <br /> 3. After that Co-Author can accept or reject the team invite and proceed with assignment submission. <br /> <br /> 4. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.<br /> <br /> ===Database Changes===<br /> As part of this project, the change in the database would be addition of a new column: 'is_conference' in 'Assignment' table with default value 0, and value = 1 if the assignment is 'conference' type.<br /> <br /> ===Files to be changed===<br /> [[Image:Design_pic.png]]<br /> <br /> ==Test Plan==<br /> <br /> Please find the below plan to test the functionality<br /> <br /> === RSpec Tests ===<br /> Please find below RSpec Test cases for this feature<br /> <br /> ====Scenario 1: Creating student type user from controller by bypassing admin approval ====<br /> After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if author is able to to create and login into a new account without admin approval<br /> <br /> ====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====<br /> After Author has created an account, he/she should be able to access the conference type account.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author is assigned to conference type assignment and able to access it<br /> *Test case to check if Co-author is assigned to conference type assignment and able to access it<br /> *Test case to check if Author has been added to default team<br /> *Test case to check if Co-author is added to Author's team<br /> <br /> ====Scenario 3: Conference type assignment being created ====<br /> Instructor should be able to create conference type assignment<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Conference type assignment has been created<br /> <br /> ====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====<br /> After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author/Co-author already have an account<br /> *Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account<br /> <br /> ==Teammates==<br /> <br /> Mentor - Prof. Edward Gehringer<br /> <br /> * Sameer Adhikari (sadhika2)<br /> * Gurman Singh (gsingh23)<br /> * Garima Garima (ggarima)<br /> * Bharat Bhardwaj (bbhardw)<br /> <br /> ==References==<br /> # [https://github.com/expertiza/expertiza Github Repository for Expertiza]<br /> # [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]<br /> # [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-E1974_Allow_users_to_create_an_account_and_submit_work_to_an_%E2%80%9Dassignment%E2%80%9D_Design&diff=129865 2019-12-06T00:12:58Z

<p>Ggarima: /* Changes for Conference's co-authors */</p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==Problem Statement==<br /> <br /> ===Existing Solution===<br /> Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.<br /> <br /> ===Proposed Solution===<br /> This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.<br /> The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.<br /> <br /> ==Task to be Accomplished==<br /> * When creating a conference type assignment, a link to join the conference will be show on the assignment page.<br /> * Instructor will share the joining link with Author and they should be able to create account using that link, if account already does not exist.<br /> * Author will be able to create a new team in &quot;Your Team&quot; section and can invite other Co-Authors to join the team.<br /> * If Co-Authors already exists in expertiza, they will be able to see invite on their homepage and if they do not exist in expertiza they will receive an email with joining link on email id used by Author while inviting them.<br /> * Once Co-Author sees the invite they can accept or reject it.<br /> <br /> ==Sequence Diagram==<br /> [[File:OSS12.png]]<br /> <br /> ==Design - The Grubby Details==<br /> <br /> ===Creating The conference type assignment===<br /> <br /> Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:<br /> <br /> 1. Instructor logs in with his credentials.<br /> <br /> 2. Instructor creates an assignment by checking a new check box - “Will this be a conference type of assignment”, to mark the assignment to be of conference type.<br /> <br /> * This checkbox will be introduced in the Assignment’s edit page ('''app/views/assignments/edit/_general.html''')<br /> <br /> 3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.<br /> <br /> * Author of the assignment will use this URL to create the team and do conference paper submission. If author does not have account already in expertiza, Author will be asked to create account.<br /> <br /> The usage of the url and working will be discussed in the next part.<br /> <br /> ===Changes for Conference's authors===<br /> <br /> Following will be the high level steps the Author would be performing to create an account:<br /> <br /> 1. Once instructor shares the joining link with potential Authors, they can use their existing expertiza accounts or create new accounts for making a team and add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.<br /> <br /> 2. When Author clicks on joining link, there could be two cases that author have expertiza account or author does not have expertiza account. <br /> <br /> *If Author already has an account he will be able to view the assignment assigned to him and a default team.<br /> *If Author does not have expertiza account, he/she will be asked to put some details to create account with role as student. After account creation, Author will receive email with login ID and password. <br /> <br /> 3. After Author logs in, he/she can navigate to '''assignment -&gt; Your Team''' and invite co-authors into his team for working on the submission.<br /> <br /> 4. When inviting the Co-Authors, Author can give Expertiza user name of Co-Author if they already exists in expertiza or Author can invite them by giving email id of Co-Author. <br /> <br /> 5. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).<br /> <br /> ===Changes for Conference's co-authors===<br /> <br /> 1. If Co-Author expertiza account already exists, when Co-Author logs in expertiza, he or she will be able to see conference assignment in homepage and team invite in &quot;Your Team&quot; section.<br /> <br /> 2. If Co-Author does not exists then he/she will receive an email with login id and password and Expertiza web address on the email id, that was used by author to invite them. When Co-Author logs in with same email id or password, he/she will be able to see conference assignment in homepage and team invite in &quot;Your Team&quot; section.<br /> <br /> 3. After that Co-Author can accept or reject the team invite and proceed with assignment submission. <br /> <br /> 4. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.<br /> <br /> ===Database Changes===<br /> As part of this project, the change in the database would be addition of a new column: 'is_conference_type_assignment' in 'Assignment' table with default value 0, and value = 1 if the assignment is of 'conference' type.<br /> <br /> ===Files to be changed===<br /> [[Image:Design_pic.png]]<br /> <br /> ==Test Plan==<br /> <br /> Please find the below plan to test the functionality<br /> <br /> === RSpec Tests ===<br /> Please find below RSpec Test cases for this feature<br /> <br /> ====Scenario 1: Creating student type user from controller by bypassing admin approval ====<br /> After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if author is able to to create and login into a new account without admin approval<br /> <br /> ====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====<br /> After Author has created an account, he/she should be able to access the conference type account.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author is assigned to conference type assignment and able to access it<br /> *Test case to check if Co-author is assigned to conference type assignment and able to access it<br /> *Test case to check if Author has been added to default team<br /> *Test case to check if Co-author is added to Author's team<br /> <br /> ====Scenario 3: Conference type assignment being created ====<br /> Instructor should be able to create conference type assignment<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Conference type assignment has been created<br /> <br /> ====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====<br /> After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author/Co-author already have an account<br /> *Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account<br /> <br /> ==Teammates==<br /> <br /> Mentor - Prof. Edward Gehringer<br /> <br /> * Sameer Adhikari (sadhika2)<br /> * Gurman Singh (gsingh23)<br /> * Garima Garima (ggarima)<br /> * Bharat Bhardwaj (bbhardw)<br /> <br /> ==References==<br /> # [https://github.com/expertiza/expertiza Github Repository for Expertiza]<br /> # [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]<br /> # [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-E1974_Allow_users_to_create_an_account_and_submit_work_to_an_%E2%80%9Dassignment%E2%80%9D_Design&diff=129864 2019-12-06T00:12:32Z

<p>Ggarima: /* Changes for Conference's co-authors */</p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==Problem Statement==<br /> <br /> ===Existing Solution===<br /> Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.<br /> <br /> ===Proposed Solution===<br /> This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.<br /> The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.<br /> <br /> ==Task to be Accomplished==<br /> * When creating a conference type assignment, a link to join the conference will be show on the assignment page.<br /> * Instructor will share the joining link with Author and they should be able to create account using that link, if account already does not exist.<br /> * Author will be able to create a new team in &quot;Your Team&quot; section and can invite other Co-Authors to join the team.<br /> * If Co-Authors already exists in expertiza, they will be able to see invite on their homepage and if they do not exist in expertiza they will receive an email with joining link on email id used by Author while inviting them.<br /> * Once Co-Author sees the invite they can accept or reject it.<br /> <br /> ==Sequence Diagram==<br /> [[File:OSS12.png]]<br /> <br /> ==Design - The Grubby Details==<br /> <br /> ===Creating The conference type assignment===<br /> <br /> Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:<br /> <br /> 1. Instructor logs in with his credentials.<br /> <br /> 2. Instructor creates an assignment by checking a new check box - “Will this be a conference type of assignment”, to mark the assignment to be of conference type.<br /> <br /> * This checkbox will be introduced in the Assignment’s edit page ('''app/views/assignments/edit/_general.html''')<br /> <br /> 3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.<br /> <br /> * Author of the assignment will use this URL to create the team and do conference paper submission. If author does not have account already in expertiza, Author will be asked to create account.<br /> <br /> The usage of the url and working will be discussed in the next part.<br /> <br /> ===Changes for Conference's authors===<br /> <br /> Following will be the high level steps the Author would be performing to create an account:<br /> <br /> 1. Once instructor shares the joining link with potential Authors, they can use their existing expertiza accounts or create new accounts for making a team and add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.<br /> <br /> 2. When Author clicks on joining link, there could be two cases that author have expertiza account or author does not have expertiza account. <br /> <br /> *If Author already has an account he will be able to view the assignment assigned to him and a default team.<br /> *If Author does not have expertiza account, he/she will be asked to put some details to create account with role as student. After account creation, Author will receive email with login ID and password. <br /> <br /> 3. After Author logs in, he/she can navigate to '''assignment -&gt; Your Team''' and invite co-authors into his team for working on the submission.<br /> <br /> 4. When inviting the Co-Authors, Author can give Expertiza user name of Co-Author if they already exists in expertiza or Author can invite them by giving email id of Co-Author. <br /> <br /> 5. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).<br /> <br /> ===Changes for Conference's co-authors===<br /> <br /> 1. If Co-Author expertiza account already exists, when Co-Author logs in expertiza, he or she will be able to see conference assignment in homepage and team invite in &quot;Your Team&quot; section.<br /> 2. If Co-Author does not exists then he/she will receive an email with login id and password and Expertiza web address on the email id, that was used by author to invite them. When Co-Author logs in with same email id or password, he/she will be able to see conference assignment in homepage and team invite in &quot;Your Team&quot; section.<br /> 3. After that Co-Author can accept or reject the team invite and proceed with assignment submission. <br /> 4. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.<br /> <br /> ===Database Changes===<br /> As part of this project, the change in the database would be addition of a new column: 'is_conference_type_assignment' in 'Assignment' table with default value 0, and value = 1 if the assignment is of 'conference' type.<br /> <br /> ===Files to be changed===<br /> [[Image:Design_pic.png]]<br /> <br /> ==Test Plan==<br /> <br /> Please find the below plan to test the functionality<br /> <br /> === RSpec Tests ===<br /> Please find below RSpec Test cases for this feature<br /> <br /> ====Scenario 1: Creating student type user from controller by bypassing admin approval ====<br /> After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if author is able to to create and login into a new account without admin approval<br /> <br /> ====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====<br /> After Author has created an account, he/she should be able to access the conference type account.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author is assigned to conference type assignment and able to access it<br /> *Test case to check if Co-author is assigned to conference type assignment and able to access it<br /> *Test case to check if Author has been added to default team<br /> *Test case to check if Co-author is added to Author's team<br /> <br /> ====Scenario 3: Conference type assignment being created ====<br /> Instructor should be able to create conference type assignment<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Conference type assignment has been created<br /> <br /> ====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====<br /> After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author/Co-author already have an account<br /> *Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account<br /> <br /> ==Teammates==<br /> <br /> Mentor - Prof. Edward Gehringer<br /> <br /> * Sameer Adhikari (sadhika2)<br /> * Gurman Singh (gsingh23)<br /> * Garima Garima (ggarima)<br /> * Bharat Bhardwaj (bbhardw)<br /> <br /> ==References==<br /> # [https://github.com/expertiza/expertiza Github Repository for Expertiza]<br /> # [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]<br /> # [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-E1974_Allow_users_to_create_an_account_and_submit_work_to_an_%E2%80%9Dassignment%E2%80%9D_Design&diff=129863 2019-12-06T00:11:52Z

<p>Ggarima: /* Changes for Conference's authors */</p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==Problem Statement==<br /> <br /> ===Existing Solution===<br /> Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.<br /> <br /> ===Proposed Solution===<br /> This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.<br /> The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.<br /> <br /> ==Task to be Accomplished==<br /> * When creating a conference type assignment, a link to join the conference will be show on the assignment page.<br /> * Instructor will share the joining link with Author and they should be able to create account using that link, if account already does not exist.<br /> * Author will be able to create a new team in &quot;Your Team&quot; section and can invite other Co-Authors to join the team.<br /> * If Co-Authors already exists in expertiza, they will be able to see invite on their homepage and if they do not exist in expertiza they will receive an email with joining link on email id used by Author while inviting them.<br /> * Once Co-Author sees the invite they can accept or reject it.<br /> <br /> ==Sequence Diagram==<br /> [[File:OSS12.png]]<br /> <br /> ==Design - The Grubby Details==<br /> <br /> ===Creating The conference type assignment===<br /> <br /> Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:<br /> <br /> 1. Instructor logs in with his credentials.<br /> <br /> 2. Instructor creates an assignment by checking a new check box - “Will this be a conference type of assignment”, to mark the assignment to be of conference type.<br /> <br /> * This checkbox will be introduced in the Assignment’s edit page ('''app/views/assignments/edit/_general.html''')<br /> <br /> 3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.<br /> <br /> * Author of the assignment will use this URL to create the team and do conference paper submission. If author does not have account already in expertiza, Author will be asked to create account.<br /> <br /> The usage of the url and working will be discussed in the next part.<br /> <br /> ===Changes for Conference's authors===<br /> <br /> Following will be the high level steps the Author would be performing to create an account:<br /> <br /> 1. Once instructor shares the joining link with potential Authors, they can use their existing expertiza accounts or create new accounts for making a team and add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.<br /> <br /> 2. When Author clicks on joining link, there could be two cases that author have expertiza account or author does not have expertiza account. <br /> <br /> *If Author already has an account he will be able to view the assignment assigned to him and a default team.<br /> *If Author does not have expertiza account, he/she will be asked to put some details to create account with role as student. After account creation, Author will receive email with login ID and password. <br /> <br /> 3. After Author logs in, he/she can navigate to '''assignment -&gt; Your Team''' and invite co-authors into his team for working on the submission.<br /> <br /> 4. When inviting the Co-Authors, Author can give Expertiza user name of Co-Author if they already exists in expertiza or Author can invite them by giving email id of Co-Author. <br /> <br /> 5. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).<br /> <br /> ===Changes for Conference's co-authors===<br /> <br /> 1. When a co-author click on the URL shared by author to join his team<br /> <br /> * If co-author already has an account, he will be asked to login and will be able to view his team and assignment.<br /> * If co-author does not exist, he will be redirected to page '''/users/request_new?role=Student'''. On this page all the details required to create a new user will be entered and a student account will be created which will not require approval from instructor for account activation.<br /> <br /> 2. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.<br /> <br /> ===Database Changes===<br /> As part of this project, the change in the database would be addition of a new column: 'is_conference_type_assignment' in 'Assignment' table with default value 0, and value = 1 if the assignment is of 'conference' type.<br /> <br /> ===Files to be changed===<br /> [[Image:Design_pic.png]]<br /> <br /> ==Test Plan==<br /> <br /> Please find the below plan to test the functionality<br /> <br /> === RSpec Tests ===<br /> Please find below RSpec Test cases for this feature<br /> <br /> ====Scenario 1: Creating student type user from controller by bypassing admin approval ====<br /> After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if author is able to to create and login into a new account without admin approval<br /> <br /> ====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====<br /> After Author has created an account, he/she should be able to access the conference type account.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author is assigned to conference type assignment and able to access it<br /> *Test case to check if Co-author is assigned to conference type assignment and able to access it<br /> *Test case to check if Author has been added to default team<br /> *Test case to check if Co-author is added to Author's team<br /> <br /> ====Scenario 3: Conference type assignment being created ====<br /> Instructor should be able to create conference type assignment<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Conference type assignment has been created<br /> <br /> ====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====<br /> After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author/Co-author already have an account<br /> *Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account<br /> <br /> ==Teammates==<br /> <br /> Mentor - Prof. Edward Gehringer<br /> <br /> * Sameer Adhikari (sadhika2)<br /> * Gurman Singh (gsingh23)<br /> * Garima Garima (ggarima)<br /> * Bharat Bhardwaj (bbhardw)<br /> <br /> ==References==<br /> # [https://github.com/expertiza/expertiza Github Repository for Expertiza]<br /> # [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]<br /> # [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-E1974_Allow_users_to_create_an_account_and_submit_work_to_an_%E2%80%9Dassignment%E2%80%9D_Design&diff=129862 2019-12-06T00:09:57Z

<p>Ggarima: /* Changes for Conference's authors */</p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==Problem Statement==<br /> <br /> ===Existing Solution===<br /> Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.<br /> <br /> ===Proposed Solution===<br /> This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.<br /> The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.<br /> <br /> ==Task to be Accomplished==<br /> * When creating a conference type assignment, a link to join the conference will be show on the assignment page.<br /> * Instructor will share the joining link with Author and they should be able to create account using that link, if account already does not exist.<br /> * Author will be able to create a new team in &quot;Your Team&quot; section and can invite other Co-Authors to join the team.<br /> * If Co-Authors already exists in expertiza, they will be able to see invite on their homepage and if they do not exist in expertiza they will receive an email with joining link on email id used by Author while inviting them.<br /> * Once Co-Author sees the invite they can accept or reject it.<br /> <br /> ==Sequence Diagram==<br /> [[File:OSS12.png]]<br /> <br /> ==Design - The Grubby Details==<br /> <br /> ===Creating The conference type assignment===<br /> <br /> Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:<br /> <br /> 1. Instructor logs in with his credentials.<br /> <br /> 2. Instructor creates an assignment by checking a new check box - “Will this be a conference type of assignment”, to mark the assignment to be of conference type.<br /> <br /> * This checkbox will be introduced in the Assignment’s edit page ('''app/views/assignments/edit/_general.html''')<br /> <br /> 3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.<br /> <br /> * Author of the assignment will use this URL to create the team and do conference paper submission. If author does not have account already in expertiza, Author will be asked to create account.<br /> <br /> The usage of the url and working will be discussed in the next part.<br /> <br /> ===Changes for Conference's authors===<br /> <br /> Following will be the high level steps the Author would be performing to create an account:<br /> <br /> 1. Once instructor shares the joining link with potential Authors, they can use their existing expertiza accounts or create new accounts for making a team and add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.<br /> <br /> 2. When Author clicks on joining link, there could be two cases that author have expertiza account or author does not have expertiza account. <br /> <br /> *If Author already has an account he will be able to view the assignment assigned to him and a default team.<br /> *If Author does not have expertiza account, he/she will be asked to put some details to create account with role as student. After account creation, Author will receive email with login ID and password. <br /> <br /> 3. After Author logs in, he/she can navigate to '''assignment -&gt; Your Team''' and invite co-authors into his team for working on the submission.<br /> <br /> 4. When inviting the Co-Authors, Author can give Expertiza user name of Co-Author if they already exists in expertiza or Author can invite them by giving email id of Co-Author. <br /> <br /> * If Co-Author expertiza account already exists, when Co-Author logs in expertiza, he or she will be able to see conference assignment in homepage and team invite in &quot;Your Team&quot; section.<br /> * If Co-Author does not exists then he/she will receive an email with login id and password and Expertiza web address on the email id, that was used by author to invite them. When Co-Author logs in with same email id or password, he/she will be able to see conference assignment in homepage and team invite in &quot;Your Team&quot; section.<br /> * After that Co-Author can accept or reject the team invite and proceed with assignment submission. <br /> <br /> 5. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).<br /> <br /> ===Changes for Conference's co-authors===<br /> <br /> 1. When a co-author click on the URL shared by author to join his team<br /> <br /> * If co-author already has an account, he will be asked to login and will be able to view his team and assignment.<br /> * If co-author does not exist, he will be redirected to page '''/users/request_new?role=Student'''. On this page all the details required to create a new user will be entered and a student account will be created which will not require approval from instructor for account activation.<br /> <br /> 2. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.<br /> <br /> ===Database Changes===<br /> As part of this project, the change in the database would be addition of a new column: 'is_conference_type_assignment' in 'Assignment' table with default value 0, and value = 1 if the assignment is of 'conference' type.<br /> <br /> ===Files to be changed===<br /> [[Image:Design_pic.png]]<br /> <br /> ==Test Plan==<br /> <br /> Please find the below plan to test the functionality<br /> <br /> === RSpec Tests ===<br /> Please find below RSpec Test cases for this feature<br /> <br /> ====Scenario 1: Creating student type user from controller by bypassing admin approval ====<br /> After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if author is able to to create and login into a new account without admin approval<br /> <br /> ====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====<br /> After Author has created an account, he/she should be able to access the conference type account.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author is assigned to conference type assignment and able to access it<br /> *Test case to check if Co-author is assigned to conference type assignment and able to access it<br /> *Test case to check if Author has been added to default team<br /> *Test case to check if Co-author is added to Author's team<br /> <br /> ====Scenario 3: Conference type assignment being created ====<br /> Instructor should be able to create conference type assignment<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Conference type assignment has been created<br /> <br /> ====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====<br /> After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author/Co-author already have an account<br /> *Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account<br /> <br /> ==Teammates==<br /> <br /> Mentor - Prof. Edward Gehringer<br /> <br /> * Sameer Adhikari (sadhika2)<br /> * Gurman Singh (gsingh23)<br /> * Garima Garima (ggarima)<br /> * Bharat Bhardwaj (bbhardw)<br /> <br /> ==References==<br /> # [https://github.com/expertiza/expertiza Github Repository for Expertiza]<br /> # [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]<br /> # [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-E1974_Allow_users_to_create_an_account_and_submit_work_to_an_%E2%80%9Dassignment%E2%80%9D_Design&diff=129861 2019-12-05T23:45:02Z

<p>Ggarima: /* Creating The conference type assignment */</p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==Problem Statement==<br /> <br /> ===Existing Solution===<br /> Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.<br /> <br /> ===Proposed Solution===<br /> This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.<br /> The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.<br /> <br /> ==Task to be Accomplished==<br /> * When creating a conference type assignment, a link to join the conference will be show on the assignment page.<br /> * Instructor will share the joining link with Author and they should be able to create account using that link, if account already does not exist.<br /> * Author will be able to create a new team in &quot;Your Team&quot; section and can invite other Co-Authors to join the team.<br /> * If Co-Authors already exists in expertiza, they will be able to see invite on their homepage and if they do not exist in expertiza they will receive an email with joining link on email id used by Author while inviting them.<br /> * Once Co-Author sees the invite they can accept or reject it.<br /> <br /> ==Sequence Diagram==<br /> [[File:OSS12.png]]<br /> <br /> ==Design - The Grubby Details==<br /> <br /> ===Creating The conference type assignment===<br /> <br /> Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:<br /> <br /> 1. Instructor logs in with his credentials.<br /> <br /> 2. Instructor creates an assignment by checking a new check box - “Will this be a conference type of assignment”, to mark the assignment to be of conference type.<br /> <br /> * This checkbox will be introduced in the Assignment’s edit page ('''app/views/assignments/edit/_general.html''')<br /> <br /> 3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.<br /> <br /> * Author of the assignment will use this URL to create the team and do conference paper submission. If author does not have account already in expertiza, Author will be asked to create account.<br /> <br /> The usage of the url and working will be discussed in the next part.<br /> <br /> ===Changes for Conference's authors===<br /> <br /> Following will be the high level steps the Author would be performing to create an account:<br /> <br /> 1. After instructor has created new assignment and a team for this assignment, instructor will be able to see a URL which will be shared by him with potential authors so that they can use their existing expertiza accounts or create new accounts to add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.<br /> <br /> 2. If Author already has an account he will be able to view the conference type assignment and his default team. If Author account does not exists he will be redirect to page '''/users/request_new?role=Student'''. On this page author can input all the required details to create author account with role as student. This account will not require any approval from instructor to activation.<br /> <br /> 3. After Author account is created, the author can add co-authors to this assignments.<br /> <br /> 4. Author can login in and navigate to '''assignment -&gt; Your Team''' and invite co-authors into his team for working on the submission.<br /> <br /> 5. Adding co-authors has following two cases - either the co-author's expertiza account already exists or a new user will be created otherwise in a similar way in which the author's account is created.<br /> <br /> 6. Author can provide email id of co-authors in invite list of “Your Team” and will be able to view a shareable URL on page '''student_teams/view?student_id={id}''', which will be shared by author to his team mates to join this team.<br /> <br /> 7. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).<br /> <br /> ===Changes for Conference's co-authors===<br /> <br /> 1. When a co-author click on the URL shared by author to join his team<br /> <br /> * If co-author already has an account, he will be asked to login and will be able to view his team and assignment.<br /> * If co-author does not exist, he will be redirected to page '''/users/request_new?role=Student'''. On this page all the details required to create a new user will be entered and a student account will be created which will not require approval from instructor for account activation.<br /> <br /> 2. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.<br /> <br /> ===Database Changes===<br /> As part of this project, the change in the database would be addition of a new column: 'is_conference_type_assignment' in 'Assignment' table with default value 0, and value = 1 if the assignment is of 'conference' type.<br /> <br /> ===Files to be changed===<br /> [[Image:Design_pic.png]]<br /> <br /> ==Test Plan==<br /> <br /> Please find the below plan to test the functionality<br /> <br /> === RSpec Tests ===<br /> Please find below RSpec Test cases for this feature<br /> <br /> ====Scenario 1: Creating student type user from controller by bypassing admin approval ====<br /> After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if author is able to to create and login into a new account without admin approval<br /> <br /> ====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====<br /> After Author has created an account, he/she should be able to access the conference type account.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author is assigned to conference type assignment and able to access it<br /> *Test case to check if Co-author is assigned to conference type assignment and able to access it<br /> *Test case to check if Author has been added to default team<br /> *Test case to check if Co-author is added to Author's team<br /> <br /> ====Scenario 3: Conference type assignment being created ====<br /> Instructor should be able to create conference type assignment<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Conference type assignment has been created<br /> <br /> ====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====<br /> After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author/Co-author already have an account<br /> *Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account<br /> <br /> ==Teammates==<br /> <br /> Mentor - Prof. Edward Gehringer<br /> <br /> * Sameer Adhikari (sadhika2)<br /> * Gurman Singh (gsingh23)<br /> * Garima Garima (ggarima)<br /> * Bharat Bhardwaj (bbhardw)<br /> <br /> ==References==<br /> # [https://github.com/expertiza/expertiza Github Repository for Expertiza]<br /> # [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]<br /> # [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-E1974_Allow_users_to_create_an_account_and_submit_work_to_an_%E2%80%9Dassignment%E2%80%9D_Design&diff=129860 2019-12-05T23:42:50Z

<p>Ggarima: /* Creating The conference type assignment */</p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==Problem Statement==<br /> <br /> ===Existing Solution===<br /> Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.<br /> <br /> ===Proposed Solution===<br /> This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.<br /> The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.<br /> <br /> ==Task to be Accomplished==<br /> * When creating a conference type assignment, a link to join the conference will be show on the assignment page.<br /> * Instructor will share the joining link with Author and they should be able to create account using that link, if account already does not exist.<br /> * Author will be able to create a new team in &quot;Your Team&quot; section and can invite other Co-Authors to join the team.<br /> * If Co-Authors already exists in expertiza, they will be able to see invite on their homepage and if they do not exist in expertiza they will receive an email with joining link on email id used by Author while inviting them.<br /> * Once Co-Author sees the invite they can accept or reject it.<br /> <br /> ==Sequence Diagram==<br /> [[File:OSS12.png]]<br /> <br /> ==Design - The Grubby Details==<br /> <br /> ===Creating The conference type assignment===<br /> <br /> Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:<br /> <br /> 1. Instructor logs in with his credentials.<br /> <br /> 2. Instructor creates an assignment by checking a new check box - “Will this be a conference type of assignment”, to mark the assignment to be of conference type.<br /> <br /> * This checkbox will be introduced in the Assignment’s edit page ('''app/views/assignments/edit/_general.html''')<br /> <br /> 3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.<br /> <br /> * Author of the assignment will use this URL to create the team and do conference paper submission. If author does not ahve account already in expertiza, Author will be asked to create assignment. Once author log in, he can create and name the team and invite Co-Authors. <br /> <br /> The usage of the url and it’s working will be discussed in the next part.<br /> <br /> ===Changes for Conference's authors===<br /> <br /> Following will be the high level steps the Author would be performing to create an account:<br /> <br /> 1. After instructor has created new assignment and a team for this assignment, instructor will be able to see a URL which will be shared by him with potential authors so that they can use their existing expertiza accounts or create new accounts to add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.<br /> <br /> 2. If Author already has an account he will be able to view the conference type assignment and his default team. If Author account does not exists he will be redirect to page '''/users/request_new?role=Student'''. On this page author can input all the required details to create author account with role as student. This account will not require any approval from instructor to activation.<br /> <br /> 3. After Author account is created, the author can add co-authors to this assignments.<br /> <br /> 4. Author can login in and navigate to '''assignment -&gt; Your Team''' and invite co-authors into his team for working on the submission.<br /> <br /> 5. Adding co-authors has following two cases - either the co-author's expertiza account already exists or a new user will be created otherwise in a similar way in which the author's account is created.<br /> <br /> 6. Author can provide email id of co-authors in invite list of “Your Team” and will be able to view a shareable URL on page '''student_teams/view?student_id={id}''', which will be shared by author to his team mates to join this team.<br /> <br /> 7. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).<br /> <br /> ===Changes for Conference's co-authors===<br /> <br /> 1. When a co-author click on the URL shared by author to join his team<br /> <br /> * If co-author already has an account, he will be asked to login and will be able to view his team and assignment.<br /> * If co-author does not exist, he will be redirected to page '''/users/request_new?role=Student'''. On this page all the details required to create a new user will be entered and a student account will be created which will not require approval from instructor for account activation.<br /> <br /> 2. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.<br /> <br /> ===Database Changes===<br /> As part of this project, the change in the database would be addition of a new column: 'is_conference_type_assignment' in 'Assignment' table with default value 0, and value = 1 if the assignment is of 'conference' type.<br /> <br /> ===Files to be changed===<br /> [[Image:Design_pic.png]]<br /> <br /> ==Test Plan==<br /> <br /> Please find the below plan to test the functionality<br /> <br /> === RSpec Tests ===<br /> Please find below RSpec Test cases for this feature<br /> <br /> ====Scenario 1: Creating student type user from controller by bypassing admin approval ====<br /> After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if author is able to to create and login into a new account without admin approval<br /> <br /> ====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====<br /> After Author has created an account, he/she should be able to access the conference type account.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author is assigned to conference type assignment and able to access it<br /> *Test case to check if Co-author is assigned to conference type assignment and able to access it<br /> *Test case to check if Author has been added to default team<br /> *Test case to check if Co-author is added to Author's team<br /> <br /> ====Scenario 3: Conference type assignment being created ====<br /> Instructor should be able to create conference type assignment<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Conference type assignment has been created<br /> <br /> ====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====<br /> After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author/Co-author already have an account<br /> *Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account<br /> <br /> ==Teammates==<br /> <br /> Mentor - Prof. Edward Gehringer<br /> <br /> * Sameer Adhikari (sadhika2)<br /> * Gurman Singh (gsingh23)<br /> * Garima Garima (ggarima)<br /> * Bharat Bhardwaj (bbhardw)<br /> <br /> ==References==<br /> # [https://github.com/expertiza/expertiza Github Repository for Expertiza]<br /> # [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]<br /> # [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-E1974_Allow_users_to_create_an_account_and_submit_work_to_an_%E2%80%9Dassignment%E2%80%9D_Design&diff=129859 2019-12-05T23:37:38Z

<p>Ggarima: /* Sequence Diagram */</p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==Problem Statement==<br /> <br /> ===Existing Solution===<br /> Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.<br /> <br /> ===Proposed Solution===<br /> This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.<br /> The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.<br /> <br /> ==Task to be Accomplished==<br /> * When creating a conference type assignment, a link to join the conference will be show on the assignment page.<br /> * Instructor will share the joining link with Author and they should be able to create account using that link, if account already does not exist.<br /> * Author will be able to create a new team in &quot;Your Team&quot; section and can invite other Co-Authors to join the team.<br /> * If Co-Authors already exists in expertiza, they will be able to see invite on their homepage and if they do not exist in expertiza they will receive an email with joining link on email id used by Author while inviting them.<br /> * Once Co-Author sees the invite they can accept or reject it.<br /> <br /> ==Sequence Diagram==<br /> [[File:OSS12.png]]<br /> <br /> ==Design - The Grubby Details==<br /> <br /> ===Creating The conference type assignment===<br /> <br /> Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:<br /> <br /> 1. Instructor logs in with his credentials.<br /> <br /> 2. Instructor creates an assignment by checking a new check box - “Will this be a conference type of assignment”, to mark the assignment to be of conference type.<br /> <br /> * This checkbox will be introduced in the Assignment’s edit page ('''app/views/assignments/edit/_general.html''')<br /> <br /> 3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.<br /> <br /> * If the student does not have an expertiza account, he/she will be asked to create an account and will not be having a need to get it authorized from the admin as only those people will be able to create an account in expertiza with whom the link is shared.<br /> <br /> The usage of the url and it’s working will be discussed in the next part.<br /> <br /> ===Changes for Conference's authors===<br /> <br /> Following will be the high level steps the Author would be performing to create an account:<br /> <br /> 1. After instructor has created new assignment and a team for this assignment, instructor will be able to see a URL which will be shared by him with potential authors so that they can use their existing expertiza accounts or create new accounts to add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.<br /> <br /> 2. If Author already has an account he will be able to view the conference type assignment and his default team. If Author account does not exists he will be redirect to page '''/users/request_new?role=Student'''. On this page author can input all the required details to create author account with role as student. This account will not require any approval from instructor to activation.<br /> <br /> 3. After Author account is created, the author can add co-authors to this assignments.<br /> <br /> 4. Author can login in and navigate to '''assignment -&gt; Your Team''' and invite co-authors into his team for working on the submission.<br /> <br /> 5. Adding co-authors has following two cases - either the co-author's expertiza account already exists or a new user will be created otherwise in a similar way in which the author's account is created.<br /> <br /> 6. Author can provide email id of co-authors in invite list of “Your Team” and will be able to view a shareable URL on page '''student_teams/view?student_id={id}''', which will be shared by author to his team mates to join this team.<br /> <br /> 7. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).<br /> <br /> ===Changes for Conference's co-authors===<br /> <br /> 1. When a co-author click on the URL shared by author to join his team<br /> <br /> * If co-author already has an account, he will be asked to login and will be able to view his team and assignment.<br /> * If co-author does not exist, he will be redirected to page '''/users/request_new?role=Student'''. On this page all the details required to create a new user will be entered and a student account will be created which will not require approval from instructor for account activation.<br /> <br /> 2. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.<br /> <br /> ===Database Changes===<br /> As part of this project, the change in the database would be addition of a new column: 'is_conference_type_assignment' in 'Assignment' table with default value 0, and value = 1 if the assignment is of 'conference' type.<br /> <br /> ===Files to be changed===<br /> [[Image:Design_pic.png]]<br /> <br /> ==Test Plan==<br /> <br /> Please find the below plan to test the functionality<br /> <br /> === RSpec Tests ===<br /> Please find below RSpec Test cases for this feature<br /> <br /> ====Scenario 1: Creating student type user from controller by bypassing admin approval ====<br /> After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if author is able to to create and login into a new account without admin approval<br /> <br /> ====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====<br /> After Author has created an account, he/she should be able to access the conference type account.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author is assigned to conference type assignment and able to access it<br /> *Test case to check if Co-author is assigned to conference type assignment and able to access it<br /> *Test case to check if Author has been added to default team<br /> *Test case to check if Co-author is added to Author's team<br /> <br /> ====Scenario 3: Conference type assignment being created ====<br /> Instructor should be able to create conference type assignment<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Conference type assignment has been created<br /> <br /> ====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====<br /> After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author/Co-author already have an account<br /> *Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account<br /> <br /> ==Teammates==<br /> <br /> Mentor - Prof. Edward Gehringer<br /> <br /> * Sameer Adhikari (sadhika2)<br /> * Gurman Singh (gsingh23)<br /> * Garima Garima (ggarima)<br /> * Bharat Bhardwaj (bbhardw)<br /> <br /> ==References==<br /> # [https://github.com/expertiza/expertiza Github Repository for Expertiza]<br /> # [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]<br /> # [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-E1974_Allow_users_to_create_an_account_and_submit_work_to_an_%E2%80%9Dassignment%E2%80%9D_Design&diff=129858 2019-12-05T23:37:22Z

<p>Ggarima: /* Sequence Diagram */</p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==Problem Statement==<br /> <br /> ===Existing Solution===<br /> Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.<br /> <br /> ===Proposed Solution===<br /> This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.<br /> The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.<br /> <br /> ==Task to be Accomplished==<br /> * When creating a conference type assignment, a link to join the conference will be show on the assignment page.<br /> * Instructor will share the joining link with Author and they should be able to create account using that link, if account already does not exist.<br /> * Author will be able to create a new team in &quot;Your Team&quot; section and can invite other Co-Authors to join the team.<br /> * If Co-Authors already exists in expertiza, they will be able to see invite on their homepage and if they do not exist in expertiza they will receive an email with joining link on email id used by Author while inviting them.<br /> * Once Co-Author sees the invite they can accept or reject it.<br /> <br /> ==Sequence Diagram==<br /> [[File:oss12.png]]<br /> <br /> ==Design - The Grubby Details==<br /> <br /> ===Creating The conference type assignment===<br /> <br /> Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:<br /> <br /> 1. Instructor logs in with his credentials.<br /> <br /> 2. Instructor creates an assignment by checking a new check box - “Will this be a conference type of assignment”, to mark the assignment to be of conference type.<br /> <br /> * This checkbox will be introduced in the Assignment’s edit page ('''app/views/assignments/edit/_general.html''')<br /> <br /> 3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.<br /> <br /> * If the student does not have an expertiza account, he/she will be asked to create an account and will not be having a need to get it authorized from the admin as only those people will be able to create an account in expertiza with whom the link is shared.<br /> <br /> The usage of the url and it’s working will be discussed in the next part.<br /> <br /> ===Changes for Conference's authors===<br /> <br /> Following will be the high level steps the Author would be performing to create an account:<br /> <br /> 1. After instructor has created new assignment and a team for this assignment, instructor will be able to see a URL which will be shared by him with potential authors so that they can use their existing expertiza accounts or create new accounts to add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.<br /> <br /> 2. If Author already has an account he will be able to view the conference type assignment and his default team. If Author account does not exists he will be redirect to page '''/users/request_new?role=Student'''. On this page author can input all the required details to create author account with role as student. This account will not require any approval from instructor to activation.<br /> <br /> 3. After Author account is created, the author can add co-authors to this assignments.<br /> <br /> 4. Author can login in and navigate to '''assignment -&gt; Your Team''' and invite co-authors into his team for working on the submission.<br /> <br /> 5. Adding co-authors has following two cases - either the co-author's expertiza account already exists or a new user will be created otherwise in a similar way in which the author's account is created.<br /> <br /> 6. Author can provide email id of co-authors in invite list of “Your Team” and will be able to view a shareable URL on page '''student_teams/view?student_id={id}''', which will be shared by author to his team mates to join this team.<br /> <br /> 7. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).<br /> <br /> ===Changes for Conference's co-authors===<br /> <br /> 1. When a co-author click on the URL shared by author to join his team<br /> <br /> * If co-author already has an account, he will be asked to login and will be able to view his team and assignment.<br /> * If co-author does not exist, he will be redirected to page '''/users/request_new?role=Student'''. On this page all the details required to create a new user will be entered and a student account will be created which will not require approval from instructor for account activation.<br /> <br /> 2. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.<br /> <br /> ===Database Changes===<br /> As part of this project, the change in the database would be addition of a new column: 'is_conference_type_assignment' in 'Assignment' table with default value 0, and value = 1 if the assignment is of 'conference' type.<br /> <br /> ===Files to be changed===<br /> [[Image:Design_pic.png]]<br /> <br /> ==Test Plan==<br /> <br /> Please find the below plan to test the functionality<br /> <br /> === RSpec Tests ===<br /> Please find below RSpec Test cases for this feature<br /> <br /> ====Scenario 1: Creating student type user from controller by bypassing admin approval ====<br /> After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if author is able to to create and login into a new account without admin approval<br /> <br /> ====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====<br /> After Author has created an account, he/she should be able to access the conference type account.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author is assigned to conference type assignment and able to access it<br /> *Test case to check if Co-author is assigned to conference type assignment and able to access it<br /> *Test case to check if Author has been added to default team<br /> *Test case to check if Co-author is added to Author's team<br /> <br /> ====Scenario 3: Conference type assignment being created ====<br /> Instructor should be able to create conference type assignment<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Conference type assignment has been created<br /> <br /> ====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====<br /> After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author/Co-author already have an account<br /> *Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account<br /> <br /> ==Teammates==<br /> <br /> Mentor - Prof. Edward Gehringer<br /> <br /> * Sameer Adhikari (sadhika2)<br /> * Gurman Singh (gsingh23)<br /> * Garima Garima (ggarima)<br /> * Bharat Bhardwaj (bbhardw)<br /> <br /> ==References==<br /> # [https://github.com/expertiza/expertiza Github Repository for Expertiza]<br /> # [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]<br /> # [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=File:OSS12.png&diff=129857 2019-12-05T23:37:10Z

<p>Ggarima: </p> <hr /> <div></div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-E1974_Allow_users_to_create_an_account_and_submit_work_to_an_%E2%80%9Dassignment%E2%80%9D_Design&diff=129856 2019-12-05T23:26:42Z

<p>Ggarima: /* Sequence Diagram */</p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==Problem Statement==<br /> <br /> ===Existing Solution===<br /> Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.<br /> <br /> ===Proposed Solution===<br /> This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.<br /> The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.<br /> <br /> ==Task to be Accomplished==<br /> * When creating a conference type assignment, a link to join the conference will be show on the assignment page.<br /> * Instructor will share the joining link with Author and they should be able to create account using that link, if account already does not exist.<br /> * Author will be able to create a new team in &quot;Your Team&quot; section and can invite other Co-Authors to join the team.<br /> * If Co-Authors already exists in expertiza, they will be able to see invite on their homepage and if they do not exist in expertiza they will receive an email with joining link on email id used by Author while inviting them.<br /> * Once Co-Author sees the invite they can accept or reject it.<br /> <br /> ==Sequence Diagram==<br /> [[File:untitled.png]]<br /> <br /> ==Design - The Grubby Details==<br /> <br /> ===Creating The conference type assignment===<br /> <br /> Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:<br /> <br /> 1. Instructor logs in with his credentials.<br /> <br /> 2. Instructor creates an assignment by checking a new check box - “Will this be a conference type of assignment”, to mark the assignment to be of conference type.<br /> <br /> * This checkbox will be introduced in the Assignment’s edit page ('''app/views/assignments/edit/_general.html''')<br /> <br /> 3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.<br /> <br /> * If the student does not have an expertiza account, he/she will be asked to create an account and will not be having a need to get it authorized from the admin as only those people will be able to create an account in expertiza with whom the link is shared.<br /> <br /> The usage of the url and it’s working will be discussed in the next part.<br /> <br /> ===Changes for Conference's authors===<br /> <br /> Following will be the high level steps the Author would be performing to create an account:<br /> <br /> 1. After instructor has created new assignment and a team for this assignment, instructor will be able to see a URL which will be shared by him with potential authors so that they can use their existing expertiza accounts or create new accounts to add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.<br /> <br /> 2. If Author already has an account he will be able to view the conference type assignment and his default team. If Author account does not exists he will be redirect to page '''/users/request_new?role=Student'''. On this page author can input all the required details to create author account with role as student. This account will not require any approval from instructor to activation.<br /> <br /> 3. After Author account is created, the author can add co-authors to this assignments.<br /> <br /> 4. Author can login in and navigate to '''assignment -&gt; Your Team''' and invite co-authors into his team for working on the submission.<br /> <br /> 5. Adding co-authors has following two cases - either the co-author's expertiza account already exists or a new user will be created otherwise in a similar way in which the author's account is created.<br /> <br /> 6. Author can provide email id of co-authors in invite list of “Your Team” and will be able to view a shareable URL on page '''student_teams/view?student_id={id}''', which will be shared by author to his team mates to join this team.<br /> <br /> 7. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).<br /> <br /> ===Changes for Conference's co-authors===<br /> <br /> 1. When a co-author click on the URL shared by author to join his team<br /> <br /> * If co-author already has an account, he will be asked to login and will be able to view his team and assignment.<br /> * If co-author does not exist, he will be redirected to page '''/users/request_new?role=Student'''. On this page all the details required to create a new user will be entered and a student account will be created which will not require approval from instructor for account activation.<br /> <br /> 2. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.<br /> <br /> ===Database Changes===<br /> As part of this project, the change in the database would be addition of a new column: 'is_conference_type_assignment' in 'Assignment' table with default value 0, and value = 1 if the assignment is of 'conference' type.<br /> <br /> ===Files to be changed===<br /> [[Image:Design_pic.png]]<br /> <br /> ==Test Plan==<br /> <br /> Please find the below plan to test the functionality<br /> <br /> === RSpec Tests ===<br /> Please find below RSpec Test cases for this feature<br /> <br /> ====Scenario 1: Creating student type user from controller by bypassing admin approval ====<br /> After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if author is able to to create and login into a new account without admin approval<br /> <br /> ====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====<br /> After Author has created an account, he/she should be able to access the conference type account.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author is assigned to conference type assignment and able to access it<br /> *Test case to check if Co-author is assigned to conference type assignment and able to access it<br /> *Test case to check if Author has been added to default team<br /> *Test case to check if Co-author is added to Author's team<br /> <br /> ====Scenario 3: Conference type assignment being created ====<br /> Instructor should be able to create conference type assignment<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Conference type assignment has been created<br /> <br /> ====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====<br /> After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author/Co-author already have an account<br /> *Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account<br /> <br /> ==Teammates==<br /> <br /> Mentor - Prof. Edward Gehringer<br /> <br /> * Sameer Adhikari (sadhika2)<br /> * Gurman Singh (gsingh23)<br /> * Garima Garima (ggarima)<br /> * Bharat Bhardwaj (bbhardw)<br /> <br /> ==References==<br /> # [https://github.com/expertiza/expertiza Github Repository for Expertiza]<br /> # [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]<br /> # [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=File:Untitled.png&diff=129855 2019-12-05T23:26:27Z

<p>Ggarima: uploaded a new version of &amp;quot;File:Untitled.png&amp;quot;</p> <hr /> <div></div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-E1974_Allow_users_to_create_an_account_and_submit_work_to_an_%E2%80%9Dassignment%E2%80%9D_Design&diff=129854 2019-12-05T23:23:50Z

<p>Ggarima: /* Sequence Diagram */</p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==Problem Statement==<br /> <br /> ===Existing Solution===<br /> Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.<br /> <br /> ===Proposed Solution===<br /> This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.<br /> The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.<br /> <br /> ==Task to be Accomplished==<br /> * When creating a conference type assignment, a link to join the conference will be show on the assignment page.<br /> * Instructor will share the joining link with Author and they should be able to create account using that link, if account already does not exist.<br /> * Author will be able to create a new team in &quot;Your Team&quot; section and can invite other Co-Authors to join the team.<br /> * If Co-Authors already exists in expertiza, they will be able to see invite on their homepage and if they do not exist in expertiza they will receive an email with joining link on email id used by Author while inviting them.<br /> * Once Co-Author sees the invite they can accept or reject it.<br /> <br /> ==Sequence Diagram==<br /> [[File:invites.png]]<br /> <br /> ==Design - The Grubby Details==<br /> <br /> ===Creating The conference type assignment===<br /> <br /> Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:<br /> <br /> 1. Instructor logs in with his credentials.<br /> <br /> 2. Instructor creates an assignment by checking a new check box - “Will this be a conference type of assignment”, to mark the assignment to be of conference type.<br /> <br /> * This checkbox will be introduced in the Assignment’s edit page ('''app/views/assignments/edit/_general.html''')<br /> <br /> 3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.<br /> <br /> * If the student does not have an expertiza account, he/she will be asked to create an account and will not be having a need to get it authorized from the admin as only those people will be able to create an account in expertiza with whom the link is shared.<br /> <br /> The usage of the url and it’s working will be discussed in the next part.<br /> <br /> ===Changes for Conference's authors===<br /> <br /> Following will be the high level steps the Author would be performing to create an account:<br /> <br /> 1. After instructor has created new assignment and a team for this assignment, instructor will be able to see a URL which will be shared by him with potential authors so that they can use their existing expertiza accounts or create new accounts to add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.<br /> <br /> 2. If Author already has an account he will be able to view the conference type assignment and his default team. If Author account does not exists he will be redirect to page '''/users/request_new?role=Student'''. On this page author can input all the required details to create author account with role as student. This account will not require any approval from instructor to activation.<br /> <br /> 3. After Author account is created, the author can add co-authors to this assignments.<br /> <br /> 4. Author can login in and navigate to '''assignment -&gt; Your Team''' and invite co-authors into his team for working on the submission.<br /> <br /> 5. Adding co-authors has following two cases - either the co-author's expertiza account already exists or a new user will be created otherwise in a similar way in which the author's account is created.<br /> <br /> 6. Author can provide email id of co-authors in invite list of “Your Team” and will be able to view a shareable URL on page '''student_teams/view?student_id={id}''', which will be shared by author to his team mates to join this team.<br /> <br /> 7. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).<br /> <br /> ===Changes for Conference's co-authors===<br /> <br /> 1. When a co-author click on the URL shared by author to join his team<br /> <br /> * If co-author already has an account, he will be asked to login and will be able to view his team and assignment.<br /> * If co-author does not exist, he will be redirected to page '''/users/request_new?role=Student'''. On this page all the details required to create a new user will be entered and a student account will be created which will not require approval from instructor for account activation.<br /> <br /> 2. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.<br /> <br /> ===Database Changes===<br /> As part of this project, the change in the database would be addition of a new column: 'is_conference_type_assignment' in 'Assignment' table with default value 0, and value = 1 if the assignment is of 'conference' type.<br /> <br /> ===Files to be changed===<br /> [[Image:Design_pic.png]]<br /> <br /> ==Test Plan==<br /> <br /> Please find the below plan to test the functionality<br /> <br /> === RSpec Tests ===<br /> Please find below RSpec Test cases for this feature<br /> <br /> ====Scenario 1: Creating student type user from controller by bypassing admin approval ====<br /> After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if author is able to to create and login into a new account without admin approval<br /> <br /> ====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====<br /> After Author has created an account, he/she should be able to access the conference type account.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author is assigned to conference type assignment and able to access it<br /> *Test case to check if Co-author is assigned to conference type assignment and able to access it<br /> *Test case to check if Author has been added to default team<br /> *Test case to check if Co-author is added to Author's team<br /> <br /> ====Scenario 3: Conference type assignment being created ====<br /> Instructor should be able to create conference type assignment<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Conference type assignment has been created<br /> <br /> ====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====<br /> After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author/Co-author already have an account<br /> *Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account<br /> <br /> ==Teammates==<br /> <br /> Mentor - Prof. Edward Gehringer<br /> <br /> * Sameer Adhikari (sadhika2)<br /> * Gurman Singh (gsingh23)<br /> * Garima Garima (ggarima)<br /> * Bharat Bhardwaj (bbhardw)<br /> <br /> ==References==<br /> # [https://github.com/expertiza/expertiza Github Repository for Expertiza]<br /> # [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]<br /> # [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=File:Invites.png&diff=129853 2019-12-05T23:23:28Z

<p>Ggarima: </p> <hr /> <div></div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-E1974_Allow_users_to_create_an_account_and_submit_work_to_an_%E2%80%9Dassignment%E2%80%9D_Design&diff=129852 2019-12-05T23:22:53Z

<p>Ggarima: /* Design - The Grubby Details */</p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==Problem Statement==<br /> <br /> ===Existing Solution===<br /> Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.<br /> <br /> ===Proposed Solution===<br /> This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.<br /> The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.<br /> <br /> ==Task to be Accomplished==<br /> * When creating a conference type assignment, a link to join the conference will be show on the assignment page.<br /> * Instructor will share the joining link with Author and they should be able to create account using that link, if account already does not exist.<br /> * Author will be able to create a new team in &quot;Your Team&quot; section and can invite other Co-Authors to join the team.<br /> * If Co-Authors already exists in expertiza, they will be able to see invite on their homepage and if they do not exist in expertiza they will receive an email with joining link on email id used by Author while inviting them.<br /> * Once Co-Author sees the invite they can accept or reject it.<br /> <br /> ==Sequence Diagram==<br /> [[File:Untitled.png]]<br /> <br /> ==Design - The Grubby Details==<br /> <br /> ===Creating The conference type assignment===<br /> <br /> Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:<br /> <br /> 1. Instructor logs in with his credentials.<br /> <br /> 2. Instructor creates an assignment by checking a new check box - “Will this be a conference type of assignment”, to mark the assignment to be of conference type.<br /> <br /> * This checkbox will be introduced in the Assignment’s edit page ('''app/views/assignments/edit/_general.html''')<br /> <br /> 3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.<br /> <br /> * If the student does not have an expertiza account, he/she will be asked to create an account and will not be having a need to get it authorized from the admin as only those people will be able to create an account in expertiza with whom the link is shared.<br /> <br /> The usage of the url and it’s working will be discussed in the next part.<br /> <br /> ===Changes for Conference's authors===<br /> <br /> Following will be the high level steps the Author would be performing to create an account:<br /> <br /> 1. After instructor has created new assignment and a team for this assignment, instructor will be able to see a URL which will be shared by him with potential authors so that they can use their existing expertiza accounts or create new accounts to add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.<br /> <br /> 2. If Author already has an account he will be able to view the conference type assignment and his default team. If Author account does not exists he will be redirect to page '''/users/request_new?role=Student'''. On this page author can input all the required details to create author account with role as student. This account will not require any approval from instructor to activation.<br /> <br /> 3. After Author account is created, the author can add co-authors to this assignments.<br /> <br /> 4. Author can login in and navigate to '''assignment -&gt; Your Team''' and invite co-authors into his team for working on the submission.<br /> <br /> 5. Adding co-authors has following two cases - either the co-author's expertiza account already exists or a new user will be created otherwise in a similar way in which the author's account is created.<br /> <br /> 6. Author can provide email id of co-authors in invite list of “Your Team” and will be able to view a shareable URL on page '''student_teams/view?student_id={id}''', which will be shared by author to his team mates to join this team.<br /> <br /> 7. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).<br /> <br /> ===Changes for Conference's co-authors===<br /> <br /> 1. When a co-author click on the URL shared by author to join his team<br /> <br /> * If co-author already has an account, he will be asked to login and will be able to view his team and assignment.<br /> * If co-author does not exist, he will be redirected to page '''/users/request_new?role=Student'''. On this page all the details required to create a new user will be entered and a student account will be created which will not require approval from instructor for account activation.<br /> <br /> 2. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.<br /> <br /> ===Database Changes===<br /> As part of this project, the change in the database would be addition of a new column: 'is_conference_type_assignment' in 'Assignment' table with default value 0, and value = 1 if the assignment is of 'conference' type.<br /> <br /> ===Files to be changed===<br /> [[Image:Design_pic.png]]<br /> <br /> ==Test Plan==<br /> <br /> Please find the below plan to test the functionality<br /> <br /> === RSpec Tests ===<br /> Please find below RSpec Test cases for this feature<br /> <br /> ====Scenario 1: Creating student type user from controller by bypassing admin approval ====<br /> After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if author is able to to create and login into a new account without admin approval<br /> <br /> ====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====<br /> After Author has created an account, he/she should be able to access the conference type account.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author is assigned to conference type assignment and able to access it<br /> *Test case to check if Co-author is assigned to conference type assignment and able to access it<br /> *Test case to check if Author has been added to default team<br /> *Test case to check if Co-author is added to Author's team<br /> <br /> ====Scenario 3: Conference type assignment being created ====<br /> Instructor should be able to create conference type assignment<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Conference type assignment has been created<br /> <br /> ====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====<br /> After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author/Co-author already have an account<br /> *Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account<br /> <br /> ==Teammates==<br /> <br /> Mentor - Prof. Edward Gehringer<br /> <br /> * Sameer Adhikari (sadhika2)<br /> * Gurman Singh (gsingh23)<br /> * Garima Garima (ggarima)<br /> * Bharat Bhardwaj (bbhardw)<br /> <br /> ==References==<br /> # [https://github.com/expertiza/expertiza Github Repository for Expertiza]<br /> # [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]<br /> # [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-E1974_Allow_users_to_create_an_account_and_submit_work_to_an_%E2%80%9Dassignment%E2%80%9D_Design&diff=129841 2019-12-05T22:24:04Z

<p>Ggarima: /* Sequence Diagram */</p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==Problem Statement==<br /> <br /> ===Existing Solution===<br /> Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.<br /> <br /> ===Proposed Solution===<br /> This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.<br /> The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.<br /> <br /> ==Task to be Accomplished==<br /> * When creating a conference type assignment, a link to join the conference will be show on the assignment page.<br /> * Instructor will share the joining link with Author and they should be able to create account using that link, if account already does not exist.<br /> * Author will be able to create a new team in &quot;Your Team&quot; section and can invite other Co-Authors to join the team.<br /> * If Co-Authors already exists in expertiza, they will be able to see invite on their homepage and if they do not exist in expertiza they will receive an email with joining link on email id used by Author while inviting them.<br /> * Once Co-Author sees the invite they can accept or reject it.<br /> <br /> ==Sequence Diagram==<br /> [[File:Untitled.png]]<br /> <br /> ==Design - The Grubby Details==<br /> <br /> ===Creating The conference type assignment===<br /> <br /> Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:<br /> <br /> 1. Instructor logs in with his credentials.<br /> <br /> 2. Instructor creates an assignment by checking a new check box - “Is conference-style assignment”, to mark the assignment to be of conference type.<br /> <br /> * This checkbox will be introduced in the Assignment’s edit page ('''app/views/assignments/edit/_general.html''')<br /> <br /> 3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.<br /> <br /> * If the student does not have an expertiza account, he/she will be asked to create an account and will not be having a need to get it authorized from the admin as only those people will be able to create an account in expertiza with whom the link is shared.<br /> <br /> The usage of the url and it’s working will be discussed in the next part.<br /> <br /> ===Changes for Conference's authors===<br /> <br /> Following will be the high level steps the Author would be performing to create an account:<br /> <br /> 1. After instructor has created new assignment and a team for this assignment, instructor will be able to see a URL which will be shared by him with potential authors so that they can use their existing expertiza accounts or create new accounts to add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.<br /> <br /> 2. If Author already has an account he will be able to view the conference type assignment and his default team. If Author account does not exists he will be redirect to page '''/users/request_new?role=Student'''. On this page author can input all the required details to create author account with role as student. This account will not require any approval from instructor to activation.<br /> <br /> 3. After Author account is created, the author can add co-authors to this assignments.<br /> <br /> 4. Author can login in and navigate to '''assignment -&gt; Your Team''' and invite co-authors into his team for working on the submission.<br /> <br /> 5. Adding co-authors has following two cases - either the co-author's expertiza account already exists or a new user will be created otherwise in a similar way in which the author's account is created.<br /> <br /> 6. Author can provide email id of co-authors in invite list of “Your Team” and will be able to view a shareable URL on page '''student_teams/view?student_id={id}''', which will be shared by author to his team mates to join this team.<br /> <br /> 7. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).<br /> <br /> ===Changes for Conference's co-authors===<br /> <br /> 1. When a co-author click on the URL shared by author to join his team<br /> <br /> * If co-author already has an account, he will be asked to login and will be able to view his team and assignment.<br /> * If co-author does not exist, he will be redirected to page '''/users/request_new?role=Student'''. On this page all the details required to create a new user will be entered and a student account will be created which will not require approval from instructor for account activation.<br /> <br /> 2. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.<br /> <br /> ===Database Changes===<br /> As part of this project, the change in the database would be addition of a new column: 'is_conference_type_assignment' in 'Assignment' table with default value 0, and value = 1 if the assignment is of 'conference' type.<br /> <br /> ===Files to be changed===<br /> [[Image:Design_pic.png]]<br /> <br /> ==Test Plan==<br /> <br /> Please find the below plan to test the functionality<br /> <br /> === RSpec Tests ===<br /> Please find below RSpec Test cases for this feature<br /> <br /> ====Scenario 1: Creating student type user from controller by bypassing admin approval ====<br /> After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if author is able to to create and login into a new account without admin approval<br /> <br /> ====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====<br /> After Author has created an account, he/she should be able to access the conference type account.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author is assigned to conference type assignment and able to access it<br /> *Test case to check if Co-author is assigned to conference type assignment and able to access it<br /> *Test case to check if Author has been added to default team<br /> *Test case to check if Co-author is added to Author's team<br /> <br /> ====Scenario 3: Conference type assignment being created ====<br /> Instructor should be able to create conference type assignment<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Conference type assignment has been created<br /> <br /> ====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====<br /> After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author/Co-author already have an account<br /> *Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account<br /> <br /> ==Teammates==<br /> <br /> Mentor - Prof. Edward Gehringer<br /> <br /> * Sameer Adhikari (sadhika2)<br /> * Gurman Singh (gsingh23)<br /> * Garima Garima (ggarima)<br /> * Bharat Bhardwaj (bbhardw)<br /> <br /> ==References==<br /> # [https://github.com/expertiza/expertiza Github Repository for Expertiza]<br /> # [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]<br /> # [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-E1974_Allow_users_to_create_an_account_and_submit_work_to_an_%E2%80%9Dassignment%E2%80%9D_Design&diff=129840 2019-12-05T22:23:55Z

<p>Ggarima: /* Sequence Diagram */</p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==Problem Statement==<br /> <br /> ===Existing Solution===<br /> Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.<br /> <br /> ===Proposed Solution===<br /> This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.<br /> The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.<br /> <br /> ==Task to be Accomplished==<br /> * When creating a conference type assignment, a link to join the conference will be show on the assignment page.<br /> * Instructor will share the joining link with Author and they should be able to create account using that link, if account already does not exist.<br /> * Author will be able to create a new team in &quot;Your Team&quot; section and can invite other Co-Authors to join the team.<br /> * If Co-Authors already exists in expertiza, they will be able to see invite on their homepage and if they do not exist in expertiza they will receive an email with joining link on email id used by Author while inviting them.<br /> * Once Co-Author sees the invite they can accept or reject it.<br /> <br /> ==Sequence Diagram==<br /> [[File:Untitled.png.png]]<br /> <br /> ==Design - The Grubby Details==<br /> <br /> ===Creating The conference type assignment===<br /> <br /> Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:<br /> <br /> 1. Instructor logs in with his credentials.<br /> <br /> 2. Instructor creates an assignment by checking a new check box - “Is conference-style assignment”, to mark the assignment to be of conference type.<br /> <br /> * This checkbox will be introduced in the Assignment’s edit page ('''app/views/assignments/edit/_general.html''')<br /> <br /> 3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.<br /> <br /> * If the student does not have an expertiza account, he/she will be asked to create an account and will not be having a need to get it authorized from the admin as only those people will be able to create an account in expertiza with whom the link is shared.<br /> <br /> The usage of the url and it’s working will be discussed in the next part.<br /> <br /> ===Changes for Conference's authors===<br /> <br /> Following will be the high level steps the Author would be performing to create an account:<br /> <br /> 1. After instructor has created new assignment and a team for this assignment, instructor will be able to see a URL which will be shared by him with potential authors so that they can use their existing expertiza accounts or create new accounts to add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.<br /> <br /> 2. If Author already has an account he will be able to view the conference type assignment and his default team. If Author account does not exists he will be redirect to page '''/users/request_new?role=Student'''. On this page author can input all the required details to create author account with role as student. This account will not require any approval from instructor to activation.<br /> <br /> 3. After Author account is created, the author can add co-authors to this assignments.<br /> <br /> 4. Author can login in and navigate to '''assignment -&gt; Your Team''' and invite co-authors into his team for working on the submission.<br /> <br /> 5. Adding co-authors has following two cases - either the co-author's expertiza account already exists or a new user will be created otherwise in a similar way in which the author's account is created.<br /> <br /> 6. Author can provide email id of co-authors in invite list of “Your Team” and will be able to view a shareable URL on page '''student_teams/view?student_id={id}''', which will be shared by author to his team mates to join this team.<br /> <br /> 7. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).<br /> <br /> ===Changes for Conference's co-authors===<br /> <br /> 1. When a co-author click on the URL shared by author to join his team<br /> <br /> * If co-author already has an account, he will be asked to login and will be able to view his team and assignment.<br /> * If co-author does not exist, he will be redirected to page '''/users/request_new?role=Student'''. On this page all the details required to create a new user will be entered and a student account will be created which will not require approval from instructor for account activation.<br /> <br /> 2. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.<br /> <br /> ===Database Changes===<br /> As part of this project, the change in the database would be addition of a new column: 'is_conference_type_assignment' in 'Assignment' table with default value 0, and value = 1 if the assignment is of 'conference' type.<br /> <br /> ===Files to be changed===<br /> [[Image:Design_pic.png]]<br /> <br /> ==Test Plan==<br /> <br /> Please find the below plan to test the functionality<br /> <br /> === RSpec Tests ===<br /> Please find below RSpec Test cases for this feature<br /> <br /> ====Scenario 1: Creating student type user from controller by bypassing admin approval ====<br /> After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if author is able to to create and login into a new account without admin approval<br /> <br /> ====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====<br /> After Author has created an account, he/she should be able to access the conference type account.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author is assigned to conference type assignment and able to access it<br /> *Test case to check if Co-author is assigned to conference type assignment and able to access it<br /> *Test case to check if Author has been added to default team<br /> *Test case to check if Co-author is added to Author's team<br /> <br /> ====Scenario 3: Conference type assignment being created ====<br /> Instructor should be able to create conference type assignment<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Conference type assignment has been created<br /> <br /> ====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====<br /> After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author/Co-author already have an account<br /> *Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account<br /> <br /> ==Teammates==<br /> <br /> Mentor - Prof. Edward Gehringer<br /> <br /> * Sameer Adhikari (sadhika2)<br /> * Gurman Singh (gsingh23)<br /> * Garima Garima (ggarima)<br /> * Bharat Bhardwaj (bbhardw)<br /> <br /> ==References==<br /> # [https://github.com/expertiza/expertiza Github Repository for Expertiza]<br /> # [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]<br /> # [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=File:Untitled.png&diff=129839 2019-12-05T22:22:50Z

<p>Ggarima: uploaded a new version of &amp;quot;File:Untitled.png&amp;quot;</p> <hr /> <div></div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-E1974_Allow_users_to_create_an_account_and_submit_work_to_an_%E2%80%9Dassignment%E2%80%9D_Design&diff=129819 2019-12-05T21:43:26Z

<p>Ggarima: /* Task to be Accomplished */</p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==Problem Statement==<br /> <br /> ===Existing Solution===<br /> Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to add those authors and co-authors as users in expertiza, assign them to the particular assignment.<br /> <br /> ===Proposed Solution===<br /> This project concentrates on the use of expertiza assignments as conferences/journals. Using these assignments, people can submit their papers and get reviews for the same.<br /> The focus of this project will be to enable a particular conference participants to create an expertiza account and teams for conference submission by minimizing the inputs required from the application admin/instructor.<br /> <br /> ==Task to be Accomplished==<br /> * When creating a conference type assignment, a link to join the conference will be show on the assignment page.<br /> * Instructor will share the joining link with Author and they should be able to create account using that link, if account already does not exist.<br /> * Author will be able to create a new team in &quot;Your Team&quot; section and can invite other Co-Authors to join the team.<br /> * If Co-Authors already exists in expertiza, they will be able to see invite on their homepage and if they do not exist in expertiza they will receive an email with joining link on email id used by Author while inviting them.<br /> * Once Co-Author sees the invite they can accept or reject it.<br /> <br /> ==Sequence Diagram==<br /> [[File:SequenceDiagram.png]]<br /> <br /> ==Design - The Grubby Details==<br /> <br /> ===Creating The conference type assignment===<br /> <br /> Following will be the high level steps the instructor would be performing to create a conference type assignment along with the changes required:<br /> <br /> 1. Instructor logs in with his credentials.<br /> <br /> 2. Instructor creates an assignment by checking a new check box - “Is conference-style assignment”, to mark the assignment to be of conference type.<br /> <br /> * This checkbox will be introduced in the Assignment’s edit page ('''app/views/assignments/edit/_general.html''')<br /> <br /> 3. Based on the flag, once the assignment is created, a shareable URL will be displayed on the assignments page that can be used by the Instructor to share among students/authors. They will use this URL to be automatically assigned the given assignment.<br /> <br /> * If the student does not have an expertiza account, he/she will be asked to create an account and will not be having a need to get it authorized from the admin as only those people will be able to create an account in expertiza with whom the link is shared.<br /> <br /> The usage of the url and it’s working will be discussed in the next part.<br /> <br /> ===Changes for Conference's authors===<br /> <br /> Following will be the high level steps the Author would be performing to create an account:<br /> <br /> 1. After instructor has created new assignment and a team for this assignment, instructor will be able to see a URL which will be shared by him with potential authors so that they can use their existing expertiza accounts or create new accounts to add submissions to the assignment. Creation of new account will not require approval from instructor/admin. URL will be visible on page '''/assignments/{id}/edit '''.<br /> <br /> 2. If Author already has an account he will be able to view the conference type assignment and his default team. If Author account does not exists he will be redirect to page '''/users/request_new?role=Student'''. On this page author can input all the required details to create author account with role as student. This account will not require any approval from instructor to activation.<br /> <br /> 3. After Author account is created, the author can add co-authors to this assignments.<br /> <br /> 4. Author can login in and navigate to '''assignment -&gt; Your Team''' and invite co-authors into his team for working on the submission.<br /> <br /> 5. Adding co-authors has following two cases - either the co-author's expertiza account already exists or a new user will be created otherwise in a similar way in which the author's account is created.<br /> <br /> 6. Author can provide email id of co-authors in invite list of “Your Team” and will be able to view a shareable URL on page '''student_teams/view?student_id={id}''', which will be shared by author to his team mates to join this team.<br /> <br /> 7. The role for both Author and Co-author is a student type because the difference in the 'conference type assignment' and a normal assignment is only in the way that users are added to it(i.e., by creating an account for themselves if they don't already have an account).<br /> <br /> ===Changes for Conference's co-authors===<br /> <br /> 1. When a co-author click on the URL shared by author to join his team<br /> <br /> * If co-author already has an account, he will be asked to login and will be able to view his team and assignment.<br /> * If co-author does not exist, he will be redirected to page '''/users/request_new?role=Student'''. On this page all the details required to create a new user will be entered and a student account will be created which will not require approval from instructor for account activation.<br /> <br /> 2. Co-author's email will be verified while creating student account to validate if co-author is same person which author intended to add on his team. This will prevent spam/fake users from joining the author's team.<br /> <br /> ===Database Changes===<br /> As part of this project, the change in the database would be addition of a new column: 'is_conference_type_assignment' in 'Assignment' table with default value 0, and value = 1 if the assignment is of 'conference' type.<br /> <br /> ===Files to be changed===<br /> [[Image:Design_pic.png]]<br /> <br /> ==Test Plan==<br /> <br /> Please find the below plan to test the functionality<br /> <br /> === RSpec Tests ===<br /> Please find below RSpec Test cases for this feature<br /> <br /> ====Scenario 1: Creating student type user from controller by bypassing admin approval ====<br /> After instructor creates a conference type assignment, author should be able to create an account and this account doesn't require approval from admin.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if author is able to to create and login into a new account without admin approval<br /> <br /> ====Scenario 2: Author/Co-author after creating an account is able to access conference type assignment====<br /> After Author has created an account, he/she should be able to access the conference type account.<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author is assigned to conference type assignment and able to access it<br /> *Test case to check if Co-author is assigned to conference type assignment and able to access it<br /> *Test case to check if Author has been added to default team<br /> *Test case to check if Co-author is added to Author's team<br /> <br /> ====Scenario 3: Conference type assignment being created ====<br /> Instructor should be able to create conference type assignment<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Conference type assignment has been created<br /> <br /> ====Scenario 4: Author/Co-author should be able to see assignment if they already have an account ====<br /> After Instructor creates a conference type assignment, Author/Co-author clicks on link provided to them. If they already have an account, they should see conference type assignment in their assignment page<br /> <br /> Files associated with this functionality:<br /> #users_controller_spec.rb<br /> <br /> Following tests will be performed to verify whether the functionality is working as desired.<br /> *Test case to check if Author/Co-author already have an account<br /> *Test case to validate if Author/Co-author can see assignment in their assignment page if they already have an account<br /> <br /> ==Teammates==<br /> <br /> Mentor - Prof. Edward Gehringer<br /> <br /> * Sameer Adhikari (sadhika2)<br /> * Gurman Singh (gsingh23)<br /> * Garima Garima (ggarima)<br /> * Bharat Bhardwaj (bbhardw)<br /> <br /> ==References==<br /> # [https://github.com/expertiza/expertiza Github Repository for Expertiza]<br /> # [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]<br /> # [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-E1974_Allow_users_to_create_an_account_and_submit_work_to_an_%E2%80%9Dassignment%E2%80%9D_Design&diff=128661 2019-11-11T20:19:35Z

<p>Ggarima: </p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==Problem Statement==<br /> Conference assignments are the type of assignments open for all the people. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to make those authors and co-authors as users in expertiza, assign them to the particular assignment and the upload the the paper by that team. Doing all these things are mundane.<br /> <br /> ==Task to be Accomplished==<br /> * Instructor should be able to create new link for Authors to join the Conference Assignments<br /> * Author should be able to create account by clicking on the link. If author doesnt have an account<br /> * Author should be assigned to a newly created team and should be able to create a link for co-authors to join the team. <br /> * Co-Authors on clicking on link should be able to join author's team and should be able to submit work for the assignment.<br /> <br /> ==Sequence Diagram==<br /> [[File:Sequence.png]]<br /> <br /> <br /> ==Teammates==<br /> <br /> Mentor - Prof. Edward Gehringer<br /> <br /> * Sameer Adhikari (sadhika2)<br /> * Gurman Singh (gsingh23)<br /> * Garima Garima (ggarima)<br /> * Bharat Bhardwaj (bbhardw)</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-E1974_Allow_users_to_create_an_account_and_submit_work_to_an_%E2%80%9Dassignment%E2%80%9D_Design&diff=128646 2019-11-11T20:04:07Z

<p>Ggarima: </p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==Problem Statement==<br /> Assignments are created in Expertiza. We can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to make those authors and co-authors as users in expertiza, assign them to the particular assignment and the upload the the paper by that team. Doing all these things are mundane.<br /> <br /> ==Task to be Accomplished==<br /> * Instructor should be able to create new link for Authors to join the Conference Assignments<br /> * Author on clicking of link participants should be able to create account if not already present.author should be able to create account by clicking on the link. If author doesnt have an account<br /> * Author should be assigned to a newly created team and should be able to create a link for co-authors to join the team. <br /> * Co-Authors on clicking on link should be able to join author's team and should be able to submit work for the assignment.<br /> <br /> ==Sequence Diagram==<br /> [[File:Sequence.png]]<br /> <br /> <br /> ==Teammates==<br /> <br /> Mentor - Prof. Edward Gehringer<br /> <br /> * Sameer Adhikari (sadhika2)<br /> * Gurman Singh (gsingh23)<br /> * Garima Garima (ggarima)<br /> * Bharat Bhardwaj (bbhardw)</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-E1974_Allow_users_to_create_an_account_and_submit_work_to_an_%E2%80%9Dassignment%E2%80%9D_Design&diff=128632 2019-11-11T19:18:14Z

<p>Ggarima: </p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==Problem Statement==<br /> Assignments are created in Expertiza, we can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to make those authors and co-authors as users in expertiza, assign them to the particular assignment and the upload the the paper by that team. Doing all these things are mundane.<br /> <br /> ==Task to be Accomplished==<br /> * Instructor should be able to create new link for Authors to join the Seminar Assignments<br /> * Author on clicking of link participants should be able to create account if not already present.<br /> * Author should be assigned to a newly created dummy team and should be able to create a link for Co-Authors to join the team.<br /> * Co-Authors on clicking on link should be able to join the team of Author's and should be able to contribute on assignment.<br /> <br /> ==Sequence Diagram==<br /> [[File:Sequence.png]]<br /> <br /> <br /> ==Teammates==<br /> <br /> Mentor - Prof. Edward Gehringer<br /> <br /> * Sameer Adhikari (sadhika2)<br /> * Gurman Singh (gsingh23)<br /> * Garima Garima (ggarima)<br /> * Bharat Bhardwaj (bbhardw)</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-E1974_Allow_users_to_create_an_account_and_submit_work_to_an_%E2%80%9Dassignment%E2%80%9D_Design&diff=128631 2019-11-11T19:16:41Z

<p>Ggarima: </p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==Problem Statement==<br /> Assignments are created in Expertiza, we can assign participants to assignments they are participating in, and they can submit their work for it. In today's scenario, participants share google doc, authors and co-authors name with instructor. Then instructor has to make those authors and co-authors as users in expertiza, assign them to the particular assignment and the upload the the paper by that team. Doing all these things are mundane.<br /> <br /> ==Task to be Accomplished==<br /> * Instructor should be able to create new link for Authors to join the Seminar Assignments<br /> * Author on clicking of link should be able to create account if not already present.<br /> * Author should be assigned to a newly created dummy team and should be able to create a link for Co-Authors to join the team<br /> * Co-Authors on clicking on link should be able to join the team of Author's and should be able to contribute on assignment<br /> <br /> ==Sequence Diagram==<br /> [[File:Sequence.png]]<br /> <br /> <br /> ==Teammates==<br /> <br /> Mentor - Prof. Edward Gehringer<br /> <br /> * Sameer Adhikari (sadhika2)<br /> * Gurman Singh (gsingh23)<br /> * Garima Garima (ggarima)<br /> * Bharat Bhardwaj (bbhardw)</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-E1974_Allow_users_to_create_an_account_and_submit_work_to_an_%E2%80%9Dassignment%E2%80%9D_Design&diff=128630 2019-11-11T19:15:45Z

<p>Ggarima: </p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==Problem Statement==<br /> Assignments are created in Expertiza, we can assign participants to assignments they are participating in, and they can submit their work for it, but that is not the scenario for now. In current scenario participants, share google doc, authors and co-authors name with instructor. Then instructor has to make those authors and co-authors as users in expertiza, assign them to the particular assignment and the upload the the paper by that team. Doing all these things are mundane.<br /> <br /> ==Task to be Accomplished==<br /> * Instructor should be able to create new link for Authors to join the Seminar Assignments<br /> * Author on clicking of link should be able to create account if not already present.<br /> * Author should be assigned to a newly created dummy team and should be able to create a link for Co-Authors to join the team<br /> * Co-Authors on clicking on link should be able to join the team of Author's and should be able to contribute on assignment<br /> <br /> ==Sequence Diagram==<br /> [[File:Sequence.png]]<br /> <br /> <br /> ==Teammates==<br /> <br /> Mentor - Prof. Edward Gehringer<br /> <br /> * Sameer Adhikari (sadhika2)<br /> * Gurman Singh (gsingh23)<br /> * Garima Garima (ggarima)<br /> * Bharat Bhardwaj (bbhardw)</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-E1974_Allow_users_to_create_an_account_and_submit_work_to_an_%E2%80%9Dassignment%E2%80%9D_Design&diff=128629 2019-11-11T19:15:18Z

<p>Ggarima: </p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==Problem Statement==<br /> Assignments are created in Expertiza, we can assign participants to assignments they are participating in, and they can submit their work for it, but that is not the scenario for now. In current scenario participants, share google doc, authors and co-authors name with instructor. Then instructor has to make those authors and co-authors as users in expertiza, assign them to the particular assignment and the upload the the paper by that team. Doing all these things are mundane.<br /> <br /> ==Task to be Accomplished==<br /> <br /> * Instructor should be able to create new link for Authors to join the Seminar Assignments<br /> * Author on clicking of link should be able to create account if not already present.<br /> * Author should be assigned to a newly created dummy team and should be able to create a link for Co-Authors to join the team<br /> * Co-Authors on clicking on link should be able to join the team of Author's and should be able to contribute on assignment<br /> <br /> <br /> ==Sequence Diagram==<br /> <br /> [[File:Sequence.png]]<br /> <br /> <br /> ==Teammates==<br /> <br /> Mentor - Prof. Edward Gehringer<br /> <br /> * Sameer Adhikari (sadhika2)<br /> * Gurman Singh (gsingh23)<br /> * Garima Garima (ggarima)<br /> * Bharat Bhardwaj (bbhardw)</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-E1974_Allow_users_to_create_an_account_and_submit_work_to_an_%E2%80%9Dassignment%E2%80%9D_Design&diff=128628 2019-11-11T19:14:36Z

<p>Ggarima: </p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ===Problem Statement===<br /> Assignments are created in Expertiza, we can assign participants to assignments they are participating in, and they can submit their work for it, but that is not the scenario for now. In current scenario participants, share google doc, authors and co-authors name with instructor. Then instructor has to make those authors and co-authors as users in expertiza, assign them to the particular assignment and the upload the the paper by that team. Doing all these things are mundane.<br /> <br /> ===Task to be Accomplished===<br /> <br /> * Instructor should be able to create new link for Authors to join the Seminar Assignments<br /> * Author on clicking of link should be able to create account if not already present.<br /> * Author should be assigned to a newly created dummy team and should be able to create a link for Co-Authors to join the team<br /> * Co-Authors on clicking on link should be able to join the team of Author's and should be able to contribute on assignment<br /> <br /> <br /> ==Sequence Diagram==<br /> <br /> [[File:Sequence.png]]<br /> <br /> <br /> ==Teammates==<br /> <br /> Mentor - Prof. Edward Gehringer<br /> <br /> * Sameer Adhikari (sadhika2)<br /> * Gurman Singh (gsingh23)<br /> * Garima Garima (ggarima)<br /> * Bharat Bhardwaj ()</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-E1974_Allow_users_to_create_an_account_and_submit_work_to_an_%E2%80%9Dassignment%E2%80%9D_Design&diff=128627 2019-11-11T19:13:30Z

<p>Ggarima: /* Problem Statement */</p> <hr /> <div>==Introduction==<br /> ===About Expertiza ===<br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ===Problem Statement===<br /> Assignments are created in Expertiza, we can assign participants to assignments they are participating in, and they can submit their work for it, but that is not the scenario for now. In current scenario participants, share google doc, authors and co-authors name with instructor. Then instructor has to make those authors and co-authors as users in expertiza, assign them to the particular assignment and the upload the the paper by that team. Doing all these things are mundane.<br /> <br /> ===Task to be Accomplished===<br /> <br /> * Instructor should be able to create new link for Authors to join the Seminar Assignments<br /> * Author on clicking of link should be able to create account if not already present.<br /> * Author should be assigned to a newly created dummy team and should be able to create a link for Co-Authors to join the team<br /> * Co-Authors on clicking on link should be able to join the team of Author's and should be able to contribute on assignment<br /> <br /> <br /> ==Sequence Diagram==<br /> <br /> [[File:Sequence.png]]<br /> <br /> <br /> ==Teammates==<br /> <br /> Mentor - Prof. Edward Gehringer<br /> <br /> * Sameer Adhikari (sadhika2)<br /> * Gurman Singh (gsingh23)<br /> * Garima Garima (ggarima)<br /> * Bharat Bhardwaj ()</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-E1974_Allow_users_to_create_an_account_and_submit_work_to_an_%E2%80%9Dassignment%E2%80%9D_Design&diff=128622 2019-11-11T19:02:08Z

<p>Ggarima: </p> <hr /> <div>==Introduction==<br /> ===About Expertiza ===<br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ===Problem Statement===<br /> Whenever someone is attending any seminar they have to submit their paper for it. Seminar is created as assignments in Expertiza backend. In today's scenario, participants just submit a google doc and share it with instructor. Then instructor has to download the paper and add it in expertiza assignment. Not only that, instructor has to create participants who is author or co- author in expertiza. All these things are done manually, which is not a good way. <br /> The following tasks is to be accomplished in this project:<br /> <br /> * Instructor should be able to create new link for Authors to join the Seminar Assignments<br /> * Author on clicking of link should be able to create account if not already present.<br /> * Implemented feature to show number of tags entered and total number of tags in Assignment page.<br /> * Implemented feature to show tagging counts dynamically when student change tagging type in score page<br /> * Added RSPEC testcases for testing changes done for tagging<br /> <br /> ===About Tagging===<br /> Expertiza has a feature of peer review where other teams can provide feedback on student's work. There is also another feature of &quot;Tags&quot;, where a student can answer if the feedback provided were helpful or not. Tags can vary from assignment to assignment but the main motive of it is to provide information on whether the feedback provides helpful information for student's assignment. The picture below shows an example of tags. <br /> <br /> <br /> ==Teammates==<br /> <br /> Mentor - Prof. Edward Gehringer<br /> <br /> * Sameer Adhikari (sadhika2)<br /> * Gurman Singh (gsingh23)<br /> * Garima Garima (ggarima)<br /> * Bharat Bhardwaj ()</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-_E1946._Refactor_Questionnaire_controller&diff=127147 2019-11-05T20:05:53Z

<p>Ggarima: </p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==About Questionnaires Controller==<br /> <br /> Questionnaire is the superclass for all kinds of questionnaires and rubrics, rubrics is used for evaluating submissions and teammate contributions, and taking quizzes and surveys. All of these are subclasses of Questionnaire. This controller is used for creating, displaying, and managing Questionnaires. Different type of questionnaire can be created in Expertiza like Review, Metareview, Teammate review, Quiz Questionnaire, Global Survey, Course Survey and many more. This Controller is widely used and malfunctions can cause many issues in different parts of the system.<br /> <br /> Below is screenshot of questionnaire on expertiza. It shows all the kinds of questionnaires we can create on expertiza. <br /> <br /> [[File:Questionnaire_1.png]]<br /> <br /> Below is screenshot of all the review questionnaire we have created till now. We can edit, delete and do many other operations on questionnaire.<br /> <br /> [[File:Questionnaire_view.png]]<br /> <br /> Below is screenshot which shows how we can edit any questionnaire. <br /> <br /> [[File:Questionnaire_edit_3.png]]<br /> <br /> ==Why Refactor Questionnaire Controller==<br /> <br /> In Questionnaires controller below are some of the problems which needs refactoring: <br /> <br /> * Renaming the methods breaking Rubys naming conventions. <br /> * Refactoring the methods doing multiple tasks and breaking them in different modules.<br /> * Reducing the length of methods longer than 50 lines of code.<br /> * Removing the string literal values used in controller.<br /> * Separating the business logic from controller and putting it in method.<br /> * Remove variables behaving same as ruby's given functionality.<br /> * Commenting the code properly for easy understanding.<br /> <br /> ==Files Modified==<br /> <br /> Below are the five files we changed as part of refactoring<br /> <br /> =====Questionnaires Controller===== <br /> This is the questionnaires_controller.rb which handles all the CRUD operation performed on any kind of questionnaire - review or surveys, add weightage to all questions, selecting type of questions. This controller holds the major part of work done for creating questions. Creating of questionnaire was one method which was extremely complicated and not well commented about what is going on. Multiple things were done in just one method which we broke in modules doing that specific task. This controller was holding the business logic as well, which we can move to model. Variables were created separate to get value from UI. At many places string literals were being hardcoded, which were made as constants.<br /> =====Questionnaire Model=====<br /> This is the questionnaire.rb model file and we have added self method in it, which will create questionnaire object for us and we will get that object in controller and process it in controller. <br /> =====Questionnaire Spec=====<br /> This is the questionnaire_controller_spec.rb file and we have changed this file in order to test the changes we have made in Questionnaire controller.<br /> =====Quiz Questionnaires Controller=====<br /> This file is quiz_questionnaires_controller.rb and was calling multiple methods of quiz questionnaire by passing questionnaire id as parameter which we have removed. <br /> =====Quiz Questionnaire Spec=====<br /> This is quiz_questionnaire_spec.rb was changed as we have removed questionnaire ID from methods in Quiz Questionnaire controller.<br /> <br /> ==User Stories==<br /> <br /> We have used Github project board to keep track of work that needs to be refactored. Below were the user stories that we have created: <br /> <br /> * '''US1''' - As a developer i want to analyse create questionnaire so that i can refactor and break it into modules.<br /> * '''US2''' - As a developer i want to refactor the create_questionnaire method by giving it meaningful name and improving code so that it does not conflict with ruby naming standard.<br /> * '''US3''' - As a developer i want to remove questionnaire_id with params[:id] so that we can remove unnecessary variables.<br /> * '''US4''' - As a developer i want to remove all hardcoded values of alternatives, min label and max label and put them in literals, so that code can be aligned to coding standards.<br /> * '''US5''' - As a developer i want to analyse why Questionnaire is being checked as QuizQuestionnaire multiple times and functionality is being changed, so that we can make quiz questionnaire same as rest.<br /> * '''US6''' - As a developer i want to analyse why questionnaire_id has been passed as parameter in many question so that i can refactor the code.<br /> * '''US7''' - As a developer i want to run rspecs in Questionnaire spec to so that i can make sure the changes made are working correct.<br /> * '''US8''' - As a developer i want to run rspecs in Quiz Questionnaire spec to so that i can make sure the changes made are working correct.<br /> <br /> ==Refactoring==<br /> <br /> =====Refactor Create Method===== <br /> This method was in questionnaires_controller.rb<br /> Create method was very long in Questionnaire controller and was not self explanatory, number of characters in one line is more than 80 and cant be seen in one window.<br /> '''Before Refactoring'''<br /> &lt;pre&gt;<br /> def create<br /> if params[:questionnaire][:name].blank?<br /> flash[:error] = 'A rubric or survey must have a title.'<br /> redirect_to controller: 'questionnaires', action: 'new', model: params[:questionnaire][:type], private: params[:questionnaire][:private]<br /> else<br /> questionnaire_private = params[:questionnaire][:private] == 'true'<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> begin<br /> @questionnaire = Object.const_get(params[:questionnaire][:type]).new if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> begin<br /> @questionnaire.private = questionnaire_private<br /> @questionnaire.name = params[:questionnaire][:name]<br /> @questionnaire.instructor_id = session[:user].id<br /> @questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> @questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> @questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> # E1903 : We are not sure of other type of cases, so have added a if statement. If there are only 5 cases, remove the if statement<br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> @questionnaire.display_type = display_type<br /> @questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> @questionnaire.save<br /> # Create node<br /> tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')<br /> flash[:success] = 'You have successfully created a questionnaire!'<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> In this user story we created self method in questionnaire model which will create questionnaire object and pass it in controller. Self method was divided in to two different modules which we then called into self. <br /> <br /> Method create_questionnaire_node(questionnaire) - This method will create a Tree node for new questionnaire in Expertiza&lt;br/&gt;<br /> &lt;pre&gt;<br /> # This method is used to create Treenode for newly created questionnaire<br /> def create_questionnaire_node(questionnaire)<br /> tree_folder = TreeFolder.where(['name like ?', questionnaire.display_type]).first<br /> <br /> if tree_folder.present?<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: questionnaire.id, type: 'QuestionnaireNode')<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> Method display_type_for_questionnaire(params) - This method will tell us about display type for new questionnaire in Expertiza&lt;br/&gt;<br /> <br /> &lt;pre&gt;<br /> # Displaying the newly created questionnaire<br /> def display_type_for_questionnaire(params)<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> <br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> <br /> display_type<br /> end<br /> &lt;/pre&gt;<br /> <br /> This method below will be the main method for creating the questionnaire object and will call the two method we have written above. <br /> Self - Assigning all variable values from UI into questionnaire object + create_questionnaire_node(questionnaire) + display_type_for_questionnaire(params)<br /> <br /> &lt;pre&gt;<br /> # This method will create a questionnaire object and will be called from controller. <br /> class &lt;&lt; self<br /> def create_new_questionnaire_obj(params, session)<br /> # Assigning values passed from UI in params[:id] to questionnaire object<br /> if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> questionnaire = Object.const_get(params[:questionnaire][:type]).new <br /> questionnaire.private = params[:questionnaire][:private] == 'true'<br /> questionnaire.name = params[:questionnaire][:name]<br /> questionnaire.instructor_id = session[:user].id<br /> questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> questionnaire.display_type = display_type_for_questionnaire(params)<br /> questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> <br /> if questionnaire.save<br /> create_questionnaire_node(questionnaire)<br /> end<br /> # returning the questionnaire object to calling method create in controller<br /> questionnaire<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Refactor Create Questionnaire Method===== <br /> <br /> This method was in questionnaires_controller.rb and in this user story after deep analysis of create_questionnaire method, we found that this method has not been called anywhere so we have '''removed''' this method from the questionnaire controller. <br /> <br /> =====Remove Unnecessary Variables=====<br /> <br /> As a part of this user story we have removed unnecessary variables in questionnaires_controller.rb file. In this file methods like add_new_questions, save_all_questions, save_questions, save_new_questions, delete_questions, local variable questionnaire_id was passed as a method argument which is not actually required since this value can be fetched from class variable @questionnaire.id or from params[:id]. So, this variable was unnecessary. Below is the one of the methods named save_all_questions which was using questionnaire_id as method parameter and we refactored.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to save all questions in current questionnaire.<br /> def save_all_questions<br /> questionnaire_id = params[:id]<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif !questionnaire_id.nil?<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> &lt;pre&gt;<br /> def save_all_questions<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif params[:id].present?<br /> redirect_to edit_questionnaire_path(params[:id])<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Hardcoded String Literals=====<br /> <br /> As a part of this user story we have made changes in questionnaires_controller.rb file. Few methods have values directly hardcoded in code, which does not justify good coding standard. To clean up this code we used constant variables which also clearly mention what value is being set by this variable. Refactoring was done in method like add_new_questions.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> questionnaire_id = params[:id] unless params[:id].nil?<br /> num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size<br /> ((num_of_existed_questions + 1)..(num_of_existed_questions + params[:question][:total_num].to_i)).each do |i|<br /> question = Object.const_get(params[:question][:type]).create(txt: '', questionnaire_id: questionnaire_id, seq: i, type: params[:question][:type], break_before: true)<br /> if question.is_a? ScoredQuestion<br /> question.weight = 1<br /> question.max_label = 'Strongly agree'<br /> question.min_label = 'Strongly disagree'<br /> end<br /> question.size = '50, 3' if question.is_a? Criterion<br /> question.alternatives = '0|1|2|3|4|5' if question.is_a? Dropdown<br /> question.size = '60, 5' if question.is_a? TextArea<br /> question.size = '30' if question.is_a? TextField<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> Constants created were: <br /> <br /> &lt;pre&gt;<br /> QUESTION_MIN_SCORE = 0<br /> QUESTION_MAX_SCORE = 1<br /> QUESTION_MAX_LABEL = 'Strongly agree'<br /> QUESTION_MIN_LABEL = 'Strongly disagree'<br /> QUESTION_CRITERION_SIZE = '50, 3'<br /> DROPDOWN_SCALE = '0|1|2|3|4|5'<br /> TEXT_AREA_SIZE = '60, 5'<br /> TEXT_FIELD_SIZE = '30'<br /> &lt;/pre&gt;<br /> <br /> We refactored the above method by making the constants and using them instead of just passing literals. We have also improved the logic by using the better conditions and variables in method.<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> num_of_existed_questions = Questionnaire.find(params[:id]).questions.size<br /> question_nums =params[:question][:total_num].to_i<br /> total_question_nums = ((num_of_existed_questions + 1)..(num_of_existed_questions + question_nums))<br /> <br /> total_question_nums.each do |i|<br /> question = Object.const_get(params[:question][:type]).create(<br /> txt: '',<br /> questionnaire_id: params[:id],<br /> seq: i,<br /> type: params[:question][:type],<br /> break_before: true<br /> )<br /> if question.is_a? ScoredQuestion<br /> question.weight = MAXIMUM_QUESTION_SCORE<br /> question.min_label = QUESTION_MIN_LABEL<br /> question.max_label = QUESTION_MAX_LABEL<br /> end<br /> <br /> question.alternatives = DROPDOWN_SCALE if question.is_a? Dropdown<br /> question.size = question_size(question)<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(params[:id].to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Unnecessary Parameters =====<br /> <br /> This change was done in Quiz_questionnaire.rb file. Questionnaire_id is the variable which has value of params[:id], this variable was passed as method parameter in many calls when calling methods of quiz questionnaire controller, but as Quiz Questionnaire is subclass of Questionnaire and the ID can be read from instance variable, we do not need to send as separate value.<br /> <br /> =====Remove Unnecessary Checks=====<br /> <br /> In few methods like save_questions checks like “@questionnaire.id if !@questionnaire.id.nil? and @questionnaire.id &gt; 0” are added. These kind of checks are unnecessary because since value of questionnaire.id will be present is @questionnaire class variable. To clear up such code we have removed unnecessary check. <br /> <br /> =====Update Questionnaire Spec=====<br /> <br /> As mentioned in US2, we have removed create_questionnaire method and we have also removed corresponding test of that method in spec file. Rest no changes were done in spec file. We had run the tests before and after refactoring and they have passed. <br /> <br /> =====Update Quiz Questionnaire Spec=====<br /> <br /> As mentioned in US3 we have removed unnecessary variables, one of the variable was questionnaire_id which was just params[:id]. This variable was passed as parameter in many of quiz questionnaire methods. we have removed this variable and method calls are changed. We have changed test cases also of all the corresponding method.<br /> <br /> ==Test Plan==<br /> <br /> Our test plan is to create or existing test cases for all the user stories we have created and run it as soon as we are completing the user story. For most of our changes we did not have to create new test cases but we have modified exiting test cases for all the functionalities that we have been modifying. We have made changes in 2 spec file and have run the test cases. <br /> <br /> Below is the screenshot of the result after running the test cases.<br /> <br /> [[File:test.jpeg]]<br /> <br /> ==LoopHoles== <br /> <br /> * In several places begin and rescue statement are used without properly understanding the functionality. Due to this critical error messages are lost and debugging those error would be difficult.<br /> * On editing any questionnaire, they are not getting updated. Values are being hardcoded at backend and questionnaire never gets updated. Issue#1550 has been created to fix this bug.<br /> <br /> ==Team==<br /> =====Mentor===== <br /> Prof. Edward Gehringer<br /> =====Members===== <br /> * Garima Garima, Ggarima<br /> * Bharat Bhardwaj, Bbhardw<br /> * Piyush Tiwari, Ptiwari<br /> <br /> ==References==<br /> <br /> #[https://expertiza.ncsu.edu/ Expertiza]<br /> #[https://github.com/expertiza/expertiza Expertiza GitHub]<br /> #[https://github.com/piyushtiw/expertiza/pull/14 Pull Request to Merge]<br /> #[http://152.7.98.234:8080/ Deployed Changes Userid - instructor6 and Password - password]<br /> #[https://github.com/piyushtiw/expertiza/projects/2 GitHub Project Board]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-_E1946._Refactor_Questionnaire_controller&diff=127146 2019-11-05T20:00:44Z

<p>Ggarima: </p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==About Questionnaires Controller==<br /> <br /> Questionnaire is the superclass for all kinds of questionnaires and rubrics, rubrics is used for evaluating submissions and teammate contributions, and taking quizzes and surveys. All of these are subclasses of Questionnaire. This controller is used for creating, displaying, and managing Questionnaires. Different type of questionnaire can be created in Expertiza like Review, Metareview, Teammate review, Quiz Questionnaire, Global Survey, Course Survey and many more. This Controller is widely used and malfunctions can cause many issues in different parts of the system.<br /> <br /> Below is screenshot of questionnaire on expertiza. It shows all the kinds of questionnaires we can create on expertiza. <br /> <br /> [[File:Questionnaire_1.png]]<br /> <br /> Below is screenshot of all the review questionnaire we have created till now. We can edit, delete and do many other operations on questionnaire.<br /> <br /> [[File:Questionnaire_view.png]]<br /> <br /> Below is screenshot which shows how we can edit any questionnaire. <br /> <br /> [[File:Questionnaire_edit_3.png]]<br /> <br /> ==Why Refactor Questionnaire Controller==<br /> <br /> In Questionnaires controller below are some of the problems which needs refactoring: <br /> <br /> * Renaming the methods breaking Rubys naming conventions. <br /> * Refactoring the methods doing multiple tasks and breaking them in different modules.<br /> * Reducing the length of methods longer than 50 lines of code.<br /> * Removing the string literal values used in controller.<br /> * Separating the business logic from controller and putting it in method.<br /> * Remove variables behaving same as ruby's given functionality.<br /> * Commenting the code properly for easy understanding.<br /> <br /> ==Files Modified==<br /> <br /> Below are the five files we changed as part of refactoring<br /> <br /> =====Questionnaires Controller===== <br /> This is the questionnaires_controller.rb which handles all the CRUD operation performed on any kind of questionnaire - review or surveys, add weightage to all questions, selecting type of questions. This controller holds the major part of work done for creating questions. Creating of questionnaire was one method which was extremely complicated and not well commented about what is going on. Multiple things were done in just one method which we broke in modules doing that specific task. This controller was holding the business logic as well, which we can move to model. Variables were created separate to get value from UI. At many places string literals were being hardcoded, which were made as constants.<br /> =====Questionnaire Model=====<br /> This is the questionnaire.rb model file and we have added self method in it, which will create questionnaire object for us and we will get that object in controller and process it in controller. <br /> =====Questionnaire Spec=====<br /> This is the questionnaire_controller_spec.rb file and we have changed this file in order to test the changes we have made in Questionnaire controller.<br /> =====Quiz Questionnaires Controller=====<br /> This file is quiz_questionnaires_controller.rb and was calling multiple methods of quiz questionnaire by passing questionnaire id as parameter which we have removed. <br /> =====Quiz Questionnaire Spec=====<br /> This is quiz_questionnaire_spec.rb was changed as we have removed questionnaire ID from methods in Quiz Questionnaire controller.<br /> <br /> ==User Stories==<br /> <br /> We have used Github project board to keep track of work that needs to be refactored. Below were the user stories that we have created: <br /> <br /> * '''US1''' - As a developer i want to analyse create questionnaire so that i can refactor and break it into modules.<br /> * '''US2''' - As a developer i want to refactor the create_questionnaire method by giving it meaningful name and improving code so that it does not conflict with ruby naming standard.<br /> * '''US3''' - As a developer i want to remove questionnaire_id with params[:id] so that we can remove unnecessary variables.<br /> * '''US4''' - As a developer i want to remove all hardcoded values of alternatives, min label and max label and put them in literals, so that code can be aligned to coding standards.<br /> * '''US5''' - As a developer i want to analyse why Questionnaire is being checked as QuizQuestionnaire multiple times and functionality is being changed, so that we can make quiz questionnaire same as rest.<br /> * '''US6''' - As a developer i want to analyse why questionnaire_id has been passed as parameter in many question so that i can refactor the code.<br /> * '''US7''' - As a developer i want to run rspecs in Questionnaire spec to so that i can make sure the changes made are working correct.<br /> * '''US8''' - As a developer i want to run rspecs in Quiz Questionnaire spec to so that i can make sure the changes made are working correct.<br /> <br /> ==Refactoring==<br /> <br /> =====Refactor Create Method===== <br /> This method was in questionnaires_controller.rb<br /> Create method was very long in Questionnaire controller and was not self explanatory, number of characters in one line is more than 80 and cant be seen in one window.<br /> '''Before Refactoring'''<br /> &lt;pre&gt;<br /> def create<br /> if params[:questionnaire][:name].blank?<br /> flash[:error] = 'A rubric or survey must have a title.'<br /> redirect_to controller: 'questionnaires', action: 'new', model: params[:questionnaire][:type], private: params[:questionnaire][:private]<br /> else<br /> questionnaire_private = params[:questionnaire][:private] == 'true'<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> begin<br /> @questionnaire = Object.const_get(params[:questionnaire][:type]).new if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> begin<br /> @questionnaire.private = questionnaire_private<br /> @questionnaire.name = params[:questionnaire][:name]<br /> @questionnaire.instructor_id = session[:user].id<br /> @questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> @questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> @questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> # E1903 : We are not sure of other type of cases, so have added a if statement. If there are only 5 cases, remove the if statement<br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> @questionnaire.display_type = display_type<br /> @questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> @questionnaire.save<br /> # Create node<br /> tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')<br /> flash[:success] = 'You have successfully created a questionnaire!'<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> In this user story we created self method in questionnaire model which will create questionnaire object and pass it in controller. Self method was divided in to two different modules which we then called into self. <br /> <br /> Method create_questionnaire_node(questionnaire) - This method will create a Tree node for new questionnaire in Expertiza&lt;br/&gt;<br /> &lt;pre&gt;<br /> # This method is used to create Treenode for newly created questionnaire<br /> def create_questionnaire_node(questionnaire)<br /> tree_folder = TreeFolder.where(['name like ?', questionnaire.display_type]).first<br /> <br /> if tree_folder.present?<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: questionnaire.id, type: 'QuestionnaireNode')<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> Method display_type_for_questionnaire(params) - This method will tell us about display type for new questionnaire in Expertiza&lt;br/&gt;<br /> <br /> &lt;pre&gt;<br /> # Displaying the newly created questionnaire<br /> def display_type_for_questionnaire(params)<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> <br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> <br /> display_type<br /> end<br /> &lt;/pre&gt;<br /> <br /> This method below will be the main method for creating the questionnaire object and will call the two method we have written above. <br /> Self - Assigning all variable values from UI into questionnaire object + create_questionnaire_node(questionnaire) + display_type_for_questionnaire(params)<br /> <br /> &lt;pre&gt;<br /> # This method will create a questionnaire object and will be called from controller. <br /> class &lt;&lt; self<br /> def create_new_questionnaire_obj(params, session)<br /> # Assigning values passed from UI in params[:id] to questionnaire object<br /> if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> questionnaire = Object.const_get(params[:questionnaire][:type]).new <br /> questionnaire.private = params[:questionnaire][:private] == 'true'<br /> questionnaire.name = params[:questionnaire][:name]<br /> questionnaire.instructor_id = session[:user].id<br /> questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> questionnaire.display_type = display_type_for_questionnaire(params)<br /> questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> <br /> if questionnaire.save<br /> create_questionnaire_node(questionnaire)<br /> end<br /> # returning the questionnaire object to calling method create in controller<br /> questionnaire<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Refactor Create Questionnaire Method===== <br /> <br /> This method was in questionnaires_controller.rb and in this user story after deep analysis of create_questionnaire method, we found that this method has not been called anywhere so we have '''removed''' this method from the questionnaire controller. <br /> <br /> =====Remove Unnecessary Variables=====<br /> <br /> As a part of this user story we have removed unnecessary variables in questionnaires_controller.rb file. In this file methods like add_new_questions, save_all_questions, save_questions, save_new_questions, delete_questions, local variable questionnaire_id was passed as a method argument which is not actually required since this value can be fetched from class variable @questionnaire.id or from params[:id]. So, this variable was unnecessary. Below is the one of the methods named save_all_questions which was using questionnaire_id as method parameter and we refactored.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to save all questions in current questionnaire.<br /> def save_all_questions<br /> questionnaire_id = params[:id]<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif !questionnaire_id.nil?<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> &lt;pre&gt;<br /> def save_all_questions<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif params[:id].present?<br /> redirect_to edit_questionnaire_path(params[:id])<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Hardcoded String Literals=====<br /> <br /> As a part of this user story we have made changes in questionnaires_controller.rb file. Few methods have values directly hardcoded in code, which does not justify good coding standard. To clean up this code we used constant variables which also clearly mention what value is being set by this variable. Refactoring was done in method like add_new_questions.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> questionnaire_id = params[:id] unless params[:id].nil?<br /> num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size<br /> ((num_of_existed_questions + 1)..(num_of_existed_questions + params[:question][:total_num].to_i)).each do |i|<br /> question = Object.const_get(params[:question][:type]).create(txt: '', questionnaire_id: questionnaire_id, seq: i, type: params[:question][:type], break_before: true)<br /> if question.is_a? ScoredQuestion<br /> question.weight = 1<br /> question.max_label = 'Strongly agree'<br /> question.min_label = 'Strongly disagree'<br /> end<br /> question.size = '50, 3' if question.is_a? Criterion<br /> question.alternatives = '0|1|2|3|4|5' if question.is_a? Dropdown<br /> question.size = '60, 5' if question.is_a? TextArea<br /> question.size = '30' if question.is_a? TextField<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> Constants created were: <br /> <br /> &lt;pre&gt;<br /> QUESTION_MIN_SCORE = 0<br /> QUESTION_MAX_SCORE = 1<br /> QUESTION_MAX_LABEL = 'Strongly agree'<br /> QUESTION_MIN_LABEL = 'Strongly disagree'<br /> QUESTION_CRITERION_SIZE = '50, 3'<br /> DROPDOWN_SCALE = '0|1|2|3|4|5'<br /> TEXT_AREA_SIZE = '60, 5'<br /> TEXT_FIELD_SIZE = '30'<br /> &lt;/pre&gt;<br /> <br /> We refactored the above method by making the constants and using them instead of just passing literals. We have also improved the logic by using the better conditions and variables in method.<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> num_of_existed_questions = Questionnaire.find(params[:id]).questions.size<br /> question_nums =params[:question][:total_num].to_i<br /> total_question_nums = ((num_of_existed_questions + 1)..(num_of_existed_questions + question_nums))<br /> <br /> total_question_nums.each do |i|<br /> question = Object.const_get(params[:question][:type]).create(<br /> txt: '',<br /> questionnaire_id: params[:id],<br /> seq: i,<br /> type: params[:question][:type],<br /> break_before: true<br /> )<br /> if question.is_a? ScoredQuestion<br /> question.weight = MAXIMUM_QUESTION_SCORE<br /> question.min_label = QUESTION_MIN_LABEL<br /> question.max_label = QUESTION_MAX_LABEL<br /> end<br /> <br /> question.alternatives = DROPDOWN_SCALE if question.is_a? Dropdown<br /> question.size = question_size(question)<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(params[:id].to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Unnecessary Parameters =====<br /> <br /> This change was done in Quiz_questionnaire.rb file. Questionnaire_id is the variable which has value of params[:id], this variable was passed as method parameter in many calls when calling methods of quiz questionnaire controller, but as Quiz Questionnaire is subclass of Questionnaire and the ID can be read from instance variable, we do not need to send as separate value.<br /> <br /> =====Remove Unnecessary Checks=====<br /> <br /> In few methods like save_questions checks like “@questionnaire.id if !@questionnaire.id.nil? and @questionnaire.id &gt; 0” are added. These kind of checks are unnecessary because since value of questionnaire.id will be present is @questionnaire class variable. To clear up such code we have removed unnecessary check. <br /> <br /> =====Update Questionnaire Spec=====<br /> <br /> As mentioned in US2, we have removed create_questionnaire method and we have also removed corresponding test of that method in spec file. Rest no changes were done in spec file. We had run the tests before and after refactoring and they have passed. <br /> <br /> =====Update Quiz Questionnaire Spec=====<br /> <br /> As mentioned in US3 we have removed unnecessary variables, one of the variable was questionnaire_id which was just params[:id]. This variable was passed as parameter in many of quiz questionnaire methods. we have removed this variable and method calls are changed. We have changed test cases also of all the corresponding method.<br /> <br /> ==Test Plan==<br /> <br /> Our test plan is to create or existing test cases for all the user stories we have created and run it as soon as we are completing the user story. For most of our changes we did not have to create new test cases but we have modified exiting test cases for all the functionalities that we have been modifying. We have made changes in 2 spec file and have run the test cases. <br /> <br /> Below is the screenshot of the result after running the test cases.<br /> <br /> [[File:test.jpeg]]<br /> <br /> ==LoopHoles== <br /> <br /> * In several places begin and rescue statement are used without properly understanding the functionality. Due to this critical error messages are lost and debugging those error would be difficult. To fix this proper error log is added and begin rescue is removed.<br /> * On editing any questionnaire, they are not getting updated. Values are being hardcoded at backend and questionnaire never gets updated. Issue#1550 has been created to fix this bug.<br /> <br /> ==Team==<br /> =====Mentor===== <br /> Prof. Edward Gehringer<br /> =====Members===== <br /> * Garima Garima, Ggarima<br /> * Bharat Bhardwaj, Bbhardw<br /> * Piyush Tiwari, Ptiwari<br /> <br /> ==References==<br /> <br /> #[https://expertiza.ncsu.edu/ Expertiza]<br /> #[https://github.com/expertiza/expertiza Expertiza GitHub]<br /> #[https://github.com/piyushtiw/expertiza/pull/14 Pull Request to Merge]<br /> #[http://152.7.98.234:8080/ Deployed Changes Userid - instructor6 and Password - password]<br /> #[https://github.com/piyushtiw/expertiza/projects/2 GitHub Project Board]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-_E1946._Refactor_Questionnaire_controller&diff=127003 2019-11-03T20:38:34Z

<p>Ggarima: </p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==About Questionnaires Controller==<br /> <br /> Questionnaire is the superclass for all kinds of questionnaires and rubrics, rubrics is used for evaluating submissions and teammate contributions, and taking quizzes and surveys. All of these are subclasses of Questionnaire. This controller is used for creating, displaying, and managing Questionnaires. Different type of questionnaire can be created in Expertiza like Review, Metareview, Teammate review, Quiz Questionnaire, Global Survey, Course Survey and many more. This Controller is widely used and malfunctions can cause many issues in different parts of the system.<br /> <br /> Below is screenshot of questionnaire on expertiza. It shows all the kinds of questionnaires we can create on expertiza. <br /> <br /> [[File:Questionnaire_1.png]]<br /> <br /> Below is screenshot of all the review questionnaire we have created till now. We can edit, delete and do many other operations on questionnaire.<br /> <br /> [[File:Questionnaire_view.png]]<br /> <br /> Below is screenshot which shows how we can edit any questionnaire. <br /> <br /> [[File:Questionnaire_edit_3.png]]<br /> <br /> ==Why Refactor Questionnaire Controller==<br /> <br /> In Questionnaires controller below are some of the problems which needs refactoring: <br /> <br /> * Renaming the methods breaking Rubys naming conventions. <br /> * Refactoring the methods doing multiple tasks and breaking them in different modules.<br /> * Reducing the length of methods longer than 50 lines of code.<br /> * Removing the string literal values used in controller.<br /> * Separating the business logic from controller and putting it in method.<br /> * Remove variables behaving same as ruby's given functionality.<br /> * Commenting the code properly for easy understanding.<br /> <br /> ==Files Modified==<br /> <br /> Below are the five files we changed as part of refactoring<br /> <br /> =====Questionnaires Controller===== <br /> This is the questionnaires_controller.rb which handles all the CRUD operation performed on any kind of questionnaire - review or surveys, add weightage to all questions, selecting type of questions. This controller holds the major part of work done for creating questions. Creating of questionnaire was one method which was extremely complicated and not well commented about what is going on. Multiple things were done in just one method which we broke in modules doing that specific task. This controller was holding the business logic as well, which we can move to model. Variables were created separate to get value from UI. At many places string literals were being hardcoded, which were made as constants.<br /> =====Questionnaire Model=====<br /> This is the questionnaire.rb model file and we have added self method in it, which will create questionnaire object for us and we will get that object in controller and process it in controller. <br /> =====Questionnaire Spec=====<br /> This is the questionnaire_controller_spec.rb file and we have changed this file in order to test the changes we have made in Questionnaire controller.<br /> =====Quiz Questionnaires Controller=====<br /> This file is quiz_questionnaires_controller.rb and was calling multiple methods of quiz questionnaire by passing questionnaire id as parameter which we have removed. <br /> =====Quiz Questionnaire Spec=====<br /> This is quiz_questionnaire_spec.rb was changed as we have removed questionnaire ID from methods in Quiz Questionnaire controller.<br /> <br /> ==User Stories==<br /> <br /> We have used Github project board to keep track of work that needs to be refactored. Below were the user stories that we have created: <br /> <br /> * '''US1''' - As a developer i want to analyse create questionnaire so that i can refactor and break it into modules.<br /> * '''US2''' - As a developer i want to refactor the create_questionnaire method by giving it meaningful name and improving code so that it does not conflict with ruby naming standard.<br /> * '''US3''' - As a developer i want to remove questionnaire_id with params[:id] so that we can remove unnecessary variables.<br /> * '''US4''' - As a developer i want to remove all hardcoded values of alternatives, min label and max label and put them in literals, so that code can be aligned to coding standards.<br /> * '''US5''' - As a developer i want to analyse why Questionnaire is being checked as QuizQuestionnaire multiple times and functionality is being changed, so that we can make quiz questionnaire same as rest.<br /> * '''US6''' - As a developer i want to analyse why questionnaire_id has been passed as parameter in many question so that i can refactor the code.<br /> * '''US7''' - As a developer i want to run rspecs in Questionnaire spec to so that i can make sure the changes made are working correct.<br /> * '''US8''' - As a developer i want to run rspecs in Quiz Questionnaire spec to so that i can make sure the changes made are working correct.<br /> <br /> ==Refactoring==<br /> <br /> =====Refactor Create Method===== <br /> This method was in questionnaires_controller.rb<br /> Create method was very long in Questionnaire controller and was not self explanatory, number of characters in one line is more than 80 and cant be seen in one window.<br /> '''Before Refactoring'''<br /> &lt;pre&gt;<br /> def create<br /> if params[:questionnaire][:name].blank?<br /> flash[:error] = 'A rubric or survey must have a title.'<br /> redirect_to controller: 'questionnaires', action: 'new', model: params[:questionnaire][:type], private: params[:questionnaire][:private]<br /> else<br /> questionnaire_private = params[:questionnaire][:private] == 'true'<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> begin<br /> @questionnaire = Object.const_get(params[:questionnaire][:type]).new if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> begin<br /> @questionnaire.private = questionnaire_private<br /> @questionnaire.name = params[:questionnaire][:name]<br /> @questionnaire.instructor_id = session[:user].id<br /> @questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> @questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> @questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> # E1903 : We are not sure of other type of cases, so have added a if statement. If there are only 5 cases, remove the if statement<br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> @questionnaire.display_type = display_type<br /> @questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> @questionnaire.save<br /> # Create node<br /> tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')<br /> flash[:success] = 'You have successfully created a questionnaire!'<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> In this user story we created self method in questionnaire model which will create questionnaire object and pass it in controller. Self method was divided in to two different modules which we then called into self. <br /> <br /> Method create_questionnaire_node(questionnaire) - This method will create a Tree node for new questionnaire in Expertiza&lt;br/&gt;<br /> &lt;pre&gt;<br /> # This method is used to create Treenode for newly created questionnaire<br /> def create_questionnaire_node(questionnaire)<br /> tree_folder = TreeFolder.where(['name like ?', questionnaire.display_type]).first<br /> <br /> if tree_folder.present?<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: questionnaire.id, type: 'QuestionnaireNode')<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> Method display_type_for_questionnaire(params) - This method will tell us about display type for new questionnaire in Expertiza&lt;br/&gt;<br /> <br /> &lt;pre&gt;<br /> # Displaying the newly created questionnaire<br /> def display_type_for_questionnaire(params)<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> <br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> <br /> display_type<br /> end<br /> &lt;/pre&gt;<br /> <br /> This method below will be the main method for creating the questionnaire object and will call the two method we have written above. <br /> Self - Assigning all variable values from UI into questionnaire object + create_questionnaire_node(questionnaire) + display_type_for_questionnaire(params)<br /> <br /> &lt;pre&gt;<br /> # This method will create a questionnaire object and will be called from controller. <br /> class &lt;&lt; self<br /> def create_new_questionnaire_obj(params, session)<br /> # Assigning values passed from UI in params[:id] to questionnaire object<br /> if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> questionnaire = Object.const_get(params[:questionnaire][:type]).new <br /> questionnaire.private = params[:questionnaire][:private] == 'true'<br /> questionnaire.name = params[:questionnaire][:name]<br /> questionnaire.instructor_id = session[:user].id<br /> questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> questionnaire.display_type = display_type_for_questionnaire(params)<br /> questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> <br /> if questionnaire.save<br /> create_questionnaire_node(questionnaire)<br /> end<br /> # returning the questionnaire object to calling method create in controller<br /> questionnaire<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Refactor Create Questionnaire Method===== <br /> <br /> This method was in questionnaires_controller.rb and in this user story after deep analysis of create_questionnaire method, we found that this method has not been called anywhere so we have '''removed''' this method from the questionnaire controller. <br /> <br /> =====Remove Unnecessary Variables=====<br /> <br /> As a part of this user story we have removed unnecessary variables in questionnaires_controller.rb file. In this file methods like add_new_questions, save_all_questions, save_questions, save_new_questions, delete_questions, local variable questionnaire_id was passed as a method argument which is not actually required since this value can be fetched from class variable @questionnaire.id or from params[:id]. So, this variable was unnecessary. Below is the one of the methods named save_all_questions which was using questionnaire_id as method parameter and we refactored.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to save all questions in current questionnaire.<br /> def save_all_questions<br /> questionnaire_id = params[:id]<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif !questionnaire_id.nil?<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> &lt;pre&gt;<br /> def save_all_questions<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif params[:id].present?<br /> redirect_to edit_questionnaire_path(params[:id])<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Hardcoded String Literals=====<br /> <br /> As a part of this user story we have made changes in questionnaires_controller.rb file. Few methods have values directly hardcoded in code, which does not justify good coding standard. To clean up this code we used constant variables which also clearly mention what value is being set by this variable. Refactoring was done in method like add_new_questions.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> questionnaire_id = params[:id] unless params[:id].nil?<br /> num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size<br /> ((num_of_existed_questions + 1)..(num_of_existed_questions + params[:question][:total_num].to_i)).each do |i|<br /> question = Object.const_get(params[:question][:type]).create(txt: '', questionnaire_id: questionnaire_id, seq: i, type: params[:question][:type], break_before: true)<br /> if question.is_a? ScoredQuestion<br /> question.weight = 1<br /> question.max_label = 'Strongly agree'<br /> question.min_label = 'Strongly disagree'<br /> end<br /> question.size = '50, 3' if question.is_a? Criterion<br /> question.alternatives = '0|1|2|3|4|5' if question.is_a? Dropdown<br /> question.size = '60, 5' if question.is_a? TextArea<br /> question.size = '30' if question.is_a? TextField<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> Constants created were: <br /> <br /> &lt;pre&gt;<br /> QUESTION_MIN_SCORE = 0<br /> QUESTION_MAX_SCORE = 1<br /> QUESTION_MAX_LABEL = 'Strongly agree'<br /> QUESTION_MIN_LABEL = 'Strongly disagree'<br /> QUESTION_CRITERION_SIZE = '50, 3'<br /> DROPDOWN_SCALE = '0|1|2|3|4|5'<br /> TEXT_AREA_SIZE = '60, 5'<br /> TEXT_FIELD_SIZE = '30'<br /> &lt;/pre&gt;<br /> <br /> We refactored the above method by making the constants and using them instead of just passing literals. We have also improved the logic by using the better conditions and variables in method.<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> num_of_existed_questions = Questionnaire.find(params[:id]).questions.size<br /> question_nums =params[:question][:total_num].to_i<br /> total_question_nums = ((num_of_existed_questions + 1)..(num_of_existed_questions + question_nums))<br /> <br /> total_question_nums.each do |i|<br /> question = Object.const_get(params[:question][:type]).create(<br /> txt: '',<br /> questionnaire_id: params[:id],<br /> seq: i,<br /> type: params[:question][:type],<br /> break_before: true<br /> )<br /> if question.is_a? ScoredQuestion<br /> question.weight = MAXIMUM_QUESTION_SCORE<br /> question.min_label = QUESTION_MIN_LABEL<br /> question.max_label = QUESTION_MAX_LABEL<br /> end<br /> <br /> question.alternatives = DROPDOWN_SCALE if question.is_a? Dropdown<br /> question.size = question_size(question)<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(params[:id].to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Unnecessary Parameters =====<br /> <br /> This change was done in Quiz_questionnaire.rb file. Questionnaire_id is the variable which has value of params[:id], this variable was passed as method parameter in many calls when call quiz questionnaire controller.<br /> <br /> =====Remove Unnecessary Checks=====<br /> <br /> In few methods like save_questions checks like “@questionnaire.id if !@questionnaire.id.nil? and @questionnaire.id &gt; 0” are added. These kind of checks are unnecessary because since value of questionnaire.id will be present is @questionnaire class variable. To clear up such code we have removed unnecessary check. <br /> <br /> =====Update Questionnaire Spec=====<br /> <br /> As mentioned in US2, we have removed create_questionnaire method and we have also removed corresponding test of that method in spec file. Rest no changes were done in spec file. We had run the tests before and after refactoring and they have passed. <br /> <br /> =====Update Quiz Questionnaire Spec=====<br /> <br /> As mentioned in US3 we have removed unnecessary variables, one of the variable was questionnaire_id which was just params[:id]. This variable was passed as parameter in many of quiz questionnaire methods. we have removed this variable and method calls are changed. We have changed test cases also of all the corresponding method.<br /> <br /> ==Test Plan==<br /> <br /> Our test plan is to create or existing test cases for all the user stories we have created and run it as soon as we are completing the user story. For most of our changes we did not have to create new test cases but we have modified exiting test cases for all the functionalities that we have been modifying. We have made changes in 2 spec file and have run the test cases. <br /> <br /> Below is the screenshot of the result after running the test cases.<br /> <br /> [[File:test.jpeg]]<br /> <br /> ==LoopHoles== <br /> <br /> * In several places begin and rescue statement are used without properly understanding the functionality. Due to this critical error messages are lost and debugging those error would be difficult. To fix this proper error log is added and begin rescue is removed.<br /> * On editing any questionnaire, they are not getting updated. Values are being hardcoded at backend and questionnaire never gets updated. Issue#1550 has been created to fix this bug.<br /> <br /> ==Team==<br /> =====Mentor===== <br /> Prof. Edward Gehringer<br /> =====Members===== <br /> * Garima Garima, Ggarima<br /> * Bharat Bhardwaj, Bbhardw<br /> * Piyush Tiwari, Ptiwari<br /> <br /> ==References==<br /> <br /> #[https://expertiza.ncsu.edu/ Expertiza]<br /> #[https://github.com/expertiza/expertiza Expertiza GitHub]<br /> #[https://github.com/piyushtiw/expertiza/pull/14 Pull Request to Merge]<br /> #[http://152.7.98.234:8080/ Deployed Changes Userid - instructor6 and Password - password]<br /> #[https://github.com/piyushtiw/expertiza/projects/2 GitHub Project Board]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-_E1946._Refactor_Questionnaire_controller&diff=127000 2019-11-03T20:25:58Z

<p>Ggarima: </p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==About Questionnaire Controller==<br /> <br /> Questionnaire is the superclass for all kinds of questionnaires and rubrics, rubrics is used for evaluating submissions and teammate contributions, and taking quizzes and surveys. All of these are subclasses of Questionnaire. This controller is used for creating, displaying, and managing Questionnaires. Different type of questionnaire can be created in Expertiza like Review, Metareview, Teammate review, Quiz Questionnaire, Global Survey, Course Survey and many more. This Controller is widely used and malfunctions can cause many issues in different parts of the system.<br /> <br /> Below is screenshot of questionnaire on expertiza. It shows all the kinds of questionnaire we can create on expertiza. <br /> <br /> [[File:Questionnaire_1.png]]<br /> <br /> Below is screenshot of all the review questionnaire we have created till now. We can edit, delete and do many other operations on questionnaire.<br /> <br /> [[File:Questionnaire_view.png]]<br /> <br /> Below is screenshot which shows how we can edit any questionnaire. <br /> <br /> [[File:Questionnaire_edit_3.png]]<br /> <br /> ==Why Refactor Questionnaire Controller==<br /> <br /> In Questionnaire controller below are some of the problems which needs refactoring: <br /> <br /> * Renaming the methods breaking Rubys naming conventions. <br /> * Refactoring the methods doing multiple tasks and breaking them in different modules.<br /> * Reducing the length of methods longer than 50 lines of code.<br /> * Removing the string literal values used in controller.<br /> * Separating the business logic from controller and putting it in method.<br /> * Remove variables behaving same as ruby's given functionality.<br /> * Commenting the code properly for easy understanding.<br /> <br /> ==Files Modified==<br /> <br /> Below are the five files we changed as part of refactoring<br /> <br /> =====Questionnaire Controller===== <br /> This is the questionnaires_controller.rb which handles all the CRUD operation performed on any kind of questionnaire - review or surveys, add weightage to all questions, selecting type of questions. This controller holds the major part of work done for creating questions. Creating of questionnaire was one method which was extremely complicated and not well commented about what is going on. Multiple things were done in just one method which we broke in modules doing that specific task. This controller was holding the business logic as well, which we can move to model. Variables were created separate to get value from UI. At many places string literals were being hardcoded, which were made as constants.<br /> =====Questionnaire Model=====<br /> This is the questionnaire.rb model file and we have added self method in it, which will create questionnaire object for us and we will get that object in controller and process it in controller. <br /> =====Questionnaire Spec=====<br /> This is the questionnaire_controller_spec.rb file and we have changed this file in order to test the changes we have made in Questionnaire controller.<br /> =====Quiz Questionnaire Controller=====<br /> This file is quiz_questionnaire_controller.rb and was calling multiple methods of quiz questionnaire by passing questionnaire id as parameter which we have removed. <br /> =====Quiz Questionnaire Spec=====<br /> This is quiz_questionnaire_spec.rb was changed as we have removed questionnaire ID from methods in Quiz Questionnaire controller.<br /> <br /> ==User Stories==<br /> <br /> We have used Github project board to keep track of work that needs to be refactored. Below were the user stories that we have created: <br /> <br /> * '''US1''' - As a developer i want to analyse create questionnaire so that i can refactor and break it into modules.<br /> * '''US2''' - As a developer i want to refactor the create_questionnaire method by giving it meaningful name and improving code so that it does not conflict with ruby naming standard.<br /> * '''US3''' - As a developer i want to remove questionnaire_id with params[:id] so that we can remove unnecessary variables.<br /> * '''US4''' - As a developer i want to remove all hardcoded values of alternatives, min label and max label and put them in literals, so that code can be aligned to coding standards.<br /> * '''US5''' - As a developer i want to analyse why Questionnaire is being checked as QuizQuestionnaire multiple times and functionality is being changed, so that we can make quiz questionnaire same as rest.<br /> * '''US6''' - As a developer i want to analyse why questionnaire_id has been passed as parameter in many question so that i can refactor the code.<br /> * '''US7''' - As a developer i want to run rspecs in Questionnaire spec to so that i can make sure the changes made are working correct.<br /> * '''US8''' - As a developer i want to run rspecs in Quiz Questionnaire spec to so that i can make sure the changes made are working correct.<br /> <br /> ==Refactoring==<br /> <br /> =====Refactor Create Method===== <br /> This method was in questionnaires_controller.rb<br /> Create method was very long in Questionnaire controller and was not self explanatory, number of characters in one line is more than 80 and cant be seen in one window.<br /> '''Before Refactoring'''<br /> &lt;pre&gt;<br /> def create<br /> if params[:questionnaire][:name].blank?<br /> flash[:error] = 'A rubric or survey must have a title.'<br /> redirect_to controller: 'questionnaires', action: 'new', model: params[:questionnaire][:type], private: params[:questionnaire][:private]<br /> else<br /> questionnaire_private = params[:questionnaire][:private] == 'true'<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> begin<br /> @questionnaire = Object.const_get(params[:questionnaire][:type]).new if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> begin<br /> @questionnaire.private = questionnaire_private<br /> @questionnaire.name = params[:questionnaire][:name]<br /> @questionnaire.instructor_id = session[:user].id<br /> @questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> @questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> @questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> # E1903 : We are not sure of other type of cases, so have added a if statement. If there are only 5 cases, remove the if statement<br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> @questionnaire.display_type = display_type<br /> @questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> @questionnaire.save<br /> # Create node<br /> tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')<br /> flash[:success] = 'You have successfully created a questionnaire!'<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> In this user story we created self method in questionnaire model which will create questionnaire object and pass it in controller. Self method was divided in to two different modules which we then called into self. <br /> <br /> Method create_questionnaire_node(questionnaire) - This method will create a Tree node for new questionnaire in Expertiza&lt;br/&gt;<br /> &lt;pre&gt;<br /> # This method is used to create Treenode for newly created questionnaire<br /> def create_questionnaire_node(questionnaire)<br /> tree_folder = TreeFolder.where(['name like ?', questionnaire.display_type]).first<br /> <br /> if tree_folder.present?<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: questionnaire.id, type: 'QuestionnaireNode')<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> Method display_type_for_questionnaire(params) - This method will tell us about display type for new questionnaire in Expertiza&lt;br/&gt;<br /> <br /> &lt;pre&gt;<br /> # Displaying the newly created questionnaire<br /> def display_type_for_questionnaire(params)<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> <br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> <br /> display_type<br /> end<br /> &lt;/pre&gt;<br /> <br /> This method below will be the main method for creating the questionnaire object and will call the two method we have written above. <br /> Self - Assigning all variable values from UI into questionnaire object + create_questionnaire_node(questionnaire) + display_type_for_questionnaire(params)<br /> <br /> &lt;pre&gt;<br /> # This method will create a questionnaire object and will be called from controller. <br /> class &lt;&lt; self<br /> def create_new_questionnaire_obj(params, session)<br /> # Assigning values passed from UI in params[:id] to questionnaire object<br /> if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> questionnaire = Object.const_get(params[:questionnaire][:type]).new <br /> questionnaire.private = params[:questionnaire][:private] == 'true'<br /> questionnaire.name = params[:questionnaire][:name]<br /> questionnaire.instructor_id = session[:user].id<br /> questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> questionnaire.display_type = display_type_for_questionnaire(params)<br /> questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> <br /> if questionnaire.save<br /> create_questionnaire_node(questionnaire)<br /> end<br /> # returning the questionnaire object to calling method create in controller<br /> questionnaire<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Refactor Create Questionnaire Method===== <br /> <br /> This method was in questionnaires_controller.rb and in this user story after deep analysis of create_questionnaire method, we found that this method has not been called anywhere so we have '''removed''' this method from the questionnaire controller. <br /> <br /> =====Remove Unnecessary Variables=====<br /> <br /> As a part of this user story we have removed unnecessary variables in questionnaires_controller.rb file. In this file methods like add_new_questions, save_all_questions, save_questions, save_new_questions, delete_questions, local variable questionnaire_id was passed as a method argument which is not actually required since this value can be fetched from class variable @questionnaire.id or from params[:id]. So, this variable was unnecessary. Below is the one of the methods named save_all_questions which was using questionnaire_id as method parameter and we refactored.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to save all questions in current questionnaire.<br /> def save_all_questions<br /> questionnaire_id = params[:id]<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif !questionnaire_id.nil?<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> &lt;pre&gt;<br /> def save_all_questions<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif params[:id].present?<br /> redirect_to edit_questionnaire_path(params[:id])<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Hardcoded String Literals=====<br /> <br /> As a part of this user story we have made changes in questionnaires_controller.rb file. Few methods have values directly hardcoded in code, which does not justify good coding standard. To clean up this code we used constant variables which also clearly mention what value is being set by this variable. Refactoring was done in method like add_new_questions.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> questionnaire_id = params[:id] unless params[:id].nil?<br /> num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size<br /> ((num_of_existed_questions + 1)..(num_of_existed_questions + params[:question][:total_num].to_i)).each do |i|<br /> question = Object.const_get(params[:question][:type]).create(txt: '', questionnaire_id: questionnaire_id, seq: i, type: params[:question][:type], break_before: true)<br /> if question.is_a? ScoredQuestion<br /> question.weight = 1<br /> question.max_label = 'Strongly agree'<br /> question.min_label = 'Strongly disagree'<br /> end<br /> question.size = '50, 3' if question.is_a? Criterion<br /> question.alternatives = '0|1|2|3|4|5' if question.is_a? Dropdown<br /> question.size = '60, 5' if question.is_a? TextArea<br /> question.size = '30' if question.is_a? TextField<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> Constants created were: <br /> <br /> &lt;pre&gt;<br /> QUESTION_MIN_SCORE = 0<br /> QUESTION_MAX_SCORE = 1<br /> QUESTION_MAX_LABEL = 'Strongly agree'<br /> QUESTION_MIN_LABEL = 'Strongly disagree'<br /> QUESTION_CRITERION_SIZE = '50, 3'<br /> DROPDOWN_SCALE = '0|1|2|3|4|5'<br /> TEXT_AREA_SIZE = '60, 5'<br /> TEXT_FIELD_SIZE = '30'<br /> &lt;/pre&gt;<br /> <br /> We refactored the above method by making the constants and using them instead of just passing literals. We have also improved the logic by using the better conditions and variables in method.<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> num_of_existed_questions = Questionnaire.find(params[:id]).questions.size<br /> question_nums =params[:question][:total_num].to_i<br /> total_question_nums = ((num_of_existed_questions + 1)..(num_of_existed_questions + question_nums))<br /> <br /> total_question_nums.each do |i|<br /> question = Object.const_get(params[:question][:type]).create(<br /> txt: '',<br /> questionnaire_id: params[:id],<br /> seq: i,<br /> type: params[:question][:type],<br /> break_before: true<br /> )<br /> if question.is_a? ScoredQuestion<br /> question.weight = MAXIMUM_QUESTION_SCORE<br /> question.min_label = QUESTION_MIN_LABEL<br /> question.max_label = QUESTION_MAX_LABEL<br /> end<br /> <br /> question.alternatives = DROPDOWN_SCALE if question.is_a? Dropdown<br /> question.size = question_size(question)<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(params[:id].to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Unnecessary Parameters =====<br /> <br /> This change was done in Quiz_questionnaire.rb file. Questionnaire_id is the variable which has value of params[:id], this variable was passed as method parameter in many calls when call quiz questionnaire controller.<br /> <br /> =====Remove Unnecessary Checks=====<br /> <br /> In few methods like save_questions checks like “@questionnaire.id if !@questionnaire.id.nil? and @questionnaire.id &gt; 0” are added. These kind of checks are unnecessary because since value of questionnaire.id will be present is @questionnaire class variable. To clear up such code we have removed unnecessary check. <br /> <br /> =====Update Questionnaire Spec=====<br /> <br /> As mentioned in US2, we have removed create_questionnaire method and we have also removed corresponding test of that method in spec file. Rest no changes were done in spec file. We had run the tests before and after refactoring and they have passed. <br /> <br /> =====Update Quiz Questionnaire Spec=====<br /> <br /> As mentioned in US3 we have removed unnecessary variables, one of the variable was questionnaire_id which was just params[:id]. This variable was passed as parameter in many of quiz questionnaire methods. we have removed this variable and method calls are changed. We have changed test cases also of all the corresponding method.<br /> <br /> ==Test Plan==<br /> <br /> Our test plan is to create or existing test cases for all the user stories we have created and run it as soon as we are completing the user story. For most of our changes we did not have to create new test cases but we have modified exiting test cases for all the functionalities that we have been modifying. We have made changes in 2 spec file and have run the test cases. <br /> <br /> Below is the screenshot of the result after running the test cases.<br /> <br /> [[File:test.jpeg]]<br /> <br /> ==LoopHoles== <br /> <br /> * In several places begin and rescue statement are used without properly understanding the functionality. Due to this critical error messages are lost and debugging those error would be difficult. To fix this proper error log is added and begin rescue is removed.<br /> * On editing any questionnaire, they are not getting updated. Values are being hardcoded at backend and questionnaire never gets updated. Issue#1550 has been created to fix this bug.<br /> <br /> ==Team==<br /> =====Mentor===== <br /> Prof. Edward Gehringer<br /> =====Members===== <br /> * Garima Garima, Ggarima<br /> * Bharat Bhardwaj, Bbhardw<br /> * Piyush Tiwari, Ptiwari<br /> <br /> ==References==<br /> <br /> #[https://expertiza.ncsu.edu/ Expertiza]<br /> #[https://github.com/expertiza/expertiza Expertiza GitHub]<br /> #[https://github.com/piyushtiw/expertiza/pull/14 Pull Request to Merge]<br /> #[http://152.7.98.234:8080/ Deployed Changes Userid - instructor6 and Password - password]<br /> #[https://github.com/piyushtiw/expertiza/projects/2 GitHub Project Board]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-_E1946._Refactor_Questionnaire_controller&diff=126998 2019-11-03T20:13:16Z

<p>Ggarima: </p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==About Questionnaire Controller==<br /> <br /> Questionnaire is the superclass for all kinds of questionnaires and rubrics, rubrics is used for evaluating submissions and teammate contributions, and taking quizzes and surveys. All of these are subclasses of Questionnaire. This controller is used for creating, displaying, and managing Questionnaires. Different type of questionnaire can be created in Expertiza like Review, Metareview, Teammate review, Quiz Questionnaire, Global Survey, Course Survey and many more. This Controller is widely used and malfunctions can cause many issues in different parts of the system.<br /> <br /> Below is screenshot of questionnaire on expertiza. It shows all the kinds of questionnaire we can create on expertiza. <br /> <br /> [[File:Questionnaire_1.png]]<br /> <br /> Below is screenshot of all the review questionnaire we have created till now. We can edit, delete and do many other operations on questionnaire.<br /> <br /> [[File:Questionnaire_view.png]]<br /> <br /> Below is screenshot which shows how we can edit any questionnaire. <br /> <br /> [[File:Questionnaire_edit_3.png]]<br /> <br /> ==Why Refactor Questionnaire Controller==<br /> <br /> In Questionnaire controller below are some of the problems which needs refactoring: <br /> <br /> * Renaming the methods breaking Rubys naming conventions. <br /> * Refactoring the methods doing multiple tasks and breaking them in different modules.<br /> * Reducing the length of methods longer than 50 lines of code.<br /> * Removing the string literal values used in controller.<br /> * Separating the business logic from controller and putting it in method.<br /> * Remove variables behaving same as ruby's given functionality.<br /> * Commenting the code properly for easy understanding.<br /> <br /> ==Files Modified==<br /> <br /> Below are the five file we changed as part of refactoring<br /> <br /> =====Questionnaire Controller===== <br /> This is the questionnaires_controller.rb which handles all the CRUD operation performed on any kind of questionnaire - review or surveys, add weightage to all questions, selecting type of questions. This controller holds the major part of work done for creating questions. Creating of questionnaire was one method which was extremely complicated and not well commented about what is going on. Multiple things were done in just one method which we broke in modules doing that specific task. This controller was holding the business logic as well, which we can move to model. Variables were created separate to get value from UI. At many places string literals were being hardcoded, which were made as constants.<br /> =====Questionnaire Model=====<br /> This is the questionnaire.rb model file and we have added self method in it, which will create questionnaire object for us and we will get that object in controller and process it in controller. <br /> =====Questionnaire Spec=====<br /> This is the questionnaire_controller_spec.rb file and we have changed this file in order to test the changes we have made in Questionnaire controller.<br /> =====Quiz Questionnaire Controller=====<br /> This file is quiz_questionnaire_controller.rb and was calling multiple methods of quiz questionnaire by passing questionnaire id as parameter which we have removed. <br /> =====Quiz Questionnaire Spec=====<br /> This is quiz_questionnaire_spec.rb was changed as we have removed questionnaire ID from methods in Quiz Questionnaire controller.<br /> <br /> ==User Stories==<br /> <br /> We have used Github project board to keep track of work that needs to be refactored. Below were the user stories that we have created: <br /> <br /> * '''US1''' - As a developer i want to analyse create questionnaire so that i can refactor and break it into modules.<br /> * '''US2''' - As a developer i want to refactor the create_questionnaire method by giving it meaningful name and improving code so that it does not conflict with ruby naming standard.<br /> * '''US3''' - As a developer i want to remove questionnaire_id with params[:id] so that we can remove unnecessary variables.<br /> * '''US4''' - As a developer i want to remove all hardcoded values of alternatives, min label and max label and put them in literals, so that code can be aligned to coding standards.<br /> * '''US5''' - As a developer i want to analyse why Questionnaire is being checked as QuizQuestionnaire multiple times and functionality is being changed, so that we can make quiz questionnaire same as rest.<br /> * '''US6''' - As a developer i want to analyse why questionnaire_id has been passed as parameter in many question so that i can refactor the code.<br /> * '''US7''' - As a developer i want to run rspecs in Questionnaire spec to so that i can make sure the changes made are working correct.<br /> * '''US8''' - As a developer i want to run rspecs in Quiz Questionnaire spec to so that i can make sure the changes made are working correct.<br /> <br /> ==Refactoring==<br /> <br /> =====Refactor Create Method===== <br /> This method was in questionnaires_controller.rb<br /> Create method was very long in Questionnaire controller and was not self explanatory, number of characters in one line is more than 80 and cant be seen in one window.<br /> '''Before Refactoring'''<br /> &lt;pre&gt;<br /> def create<br /> if params[:questionnaire][:name].blank?<br /> flash[:error] = 'A rubric or survey must have a title.'<br /> redirect_to controller: 'questionnaires', action: 'new', model: params[:questionnaire][:type], private: params[:questionnaire][:private]<br /> else<br /> questionnaire_private = params[:questionnaire][:private] == 'true'<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> begin<br /> @questionnaire = Object.const_get(params[:questionnaire][:type]).new if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> begin<br /> @questionnaire.private = questionnaire_private<br /> @questionnaire.name = params[:questionnaire][:name]<br /> @questionnaire.instructor_id = session[:user].id<br /> @questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> @questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> @questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> # E1903 : We are not sure of other type of cases, so have added a if statement. If there are only 5 cases, remove the if statement<br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> @questionnaire.display_type = display_type<br /> @questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> @questionnaire.save<br /> # Create node<br /> tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')<br /> flash[:success] = 'You have successfully created a questionnaire!'<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> In this user story we created self method in questionnaire model which will create questionnaire object and pass it in controller. Self method was divided in to two different modules which we then called into self. <br /> <br /> Method create_questionnaire_node(questionnaire) - This method will create a Tree node for new questionnaire in Expertiza&lt;br/&gt;<br /> &lt;pre&gt;<br /> # This method is used to create Treenode for newly created questionnaire<br /> def create_questionnaire_node(questionnaire)<br /> tree_folder = TreeFolder.where(['name like ?', questionnaire.display_type]).first<br /> <br /> if tree_folder.present?<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: questionnaire.id, type: 'QuestionnaireNode')<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> Method display_type_for_questionnaire(params) - This method will tell us about display type for new questionnaire in Expertiza&lt;br/&gt;<br /> <br /> &lt;pre&gt;<br /> # Displaying the newly created questionnaire<br /> def display_type_for_questionnaire(params)<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> <br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> <br /> display_type<br /> end<br /> &lt;/pre&gt;<br /> <br /> This method below will be the main method for creating the questionnaire object and will call the two method we have written above. <br /> Self - Assigning all variable values from UI into questionnaire object + create_questionnaire_node(questionnaire) + display_type_for_questionnaire(params)<br /> <br /> &lt;pre&gt;<br /> # This method will create a questionnaire object and will be called from controller. <br /> class &lt;&lt; self<br /> def create_new_questionnaire_obj(params, session)<br /> # Assigning values passed from UI in params[:id] to questionnaire object<br /> if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> questionnaire = Object.const_get(params[:questionnaire][:type]).new <br /> questionnaire.private = params[:questionnaire][:private] == 'true'<br /> questionnaire.name = params[:questionnaire][:name]<br /> questionnaire.instructor_id = session[:user].id<br /> questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> questionnaire.display_type = display_type_for_questionnaire(params)<br /> questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> <br /> if questionnaire.save<br /> create_questionnaire_node(questionnaire)<br /> end<br /> # returning the questionnaire object to calling method create in controller<br /> questionnaire<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Refactor Create Questionnaire Method===== <br /> <br /> This method was in questionnaires_controller.rb and in this user story after deep analysis of create_questionnaire method, we found that this method has not been called anywhere so we have '''removed''' this method from the questionnaire controller. <br /> <br /> =====Remove Unnecessary Variables=====<br /> <br /> As a part of this user story we have removed unnecessary variables in questionnaires_controller.rb file. In this file methods like add_new_questions, save_all_questions, save_questions, save_new_questions, delete_questions, local variable questionnaire_id was passed as a method argument which is not actually required since this value can be fetched from class variable @questionnaire.id or from params[:id]. So, this variable was unnecessary. Below is the one of the methods named save_all_questions which was using questionnaire_id as method parameter and we refactored.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to save all questions in current questionnaire.<br /> def save_all_questions<br /> questionnaire_id = params[:id]<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif !questionnaire_id.nil?<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> &lt;pre&gt;<br /> def save_all_questions<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif params[:id].present?<br /> redirect_to edit_questionnaire_path(params[:id])<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Hardcoded String Literals=====<br /> <br /> As a part of this user story we have made changes in questionnaires_controller.rb file. Few methods have values directly hardcoded in code, which does not justify good coding standard. To clean up this code we used constant variables which also clearly mention what value is being set by this variable. Refactoring was done in method like add_new_questions.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> questionnaire_id = params[:id] unless params[:id].nil?<br /> num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size<br /> ((num_of_existed_questions + 1)..(num_of_existed_questions + params[:question][:total_num].to_i)).each do |i|<br /> question = Object.const_get(params[:question][:type]).create(txt: '', questionnaire_id: questionnaire_id, seq: i, type: params[:question][:type], break_before: true)<br /> if question.is_a? ScoredQuestion<br /> question.weight = 1<br /> question.max_label = 'Strongly agree'<br /> question.min_label = 'Strongly disagree'<br /> end<br /> question.size = '50, 3' if question.is_a? Criterion<br /> question.alternatives = '0|1|2|3|4|5' if question.is_a? Dropdown<br /> question.size = '60, 5' if question.is_a? TextArea<br /> question.size = '30' if question.is_a? TextField<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> Constants created were: <br /> <br /> &lt;pre&gt;<br /> QUESTION_MIN_SCORE = 0<br /> QUESTION_MAX_SCORE = 1<br /> QUESTION_MAX_LABEL = 'Strongly agree'<br /> QUESTION_MIN_LABEL = 'Strongly disagree'<br /> QUESTION_CRITERION_SIZE = '50, 3'<br /> DROPDOWN_SCALE = '0|1|2|3|4|5'<br /> TEXT_AREA_SIZE = '60, 5'<br /> TEXT_FIELD_SIZE = '30'<br /> &lt;/pre&gt;<br /> <br /> We refactored the above method by making the constants and using them instead of just passing literals. We have also improved the logic by using the better conditions and variables in method.<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> num_of_existed_questions = Questionnaire.find(params[:id]).questions.size<br /> question_nums =params[:question][:total_num].to_i<br /> total_question_nums = ((num_of_existed_questions + 1)..(num_of_existed_questions + question_nums))<br /> <br /> total_question_nums.each do |i|<br /> question = Object.const_get(params[:question][:type]).create(<br /> txt: '',<br /> questionnaire_id: params[:id],<br /> seq: i,<br /> type: params[:question][:type],<br /> break_before: true<br /> )<br /> if question.is_a? ScoredQuestion<br /> question.weight = MAXIMUM_QUESTION_SCORE<br /> question.min_label = QUESTION_MIN_LABEL<br /> question.max_label = QUESTION_MAX_LABEL<br /> end<br /> <br /> question.alternatives = DROPDOWN_SCALE if question.is_a? Dropdown<br /> question.size = question_size(question)<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(params[:id].to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Unnecessary Parameters =====<br /> <br /> This change was done in Quiz_questionnaire.rb file. Questionnaire_id is the variable which has value of params[:id], this variable was passed as method parameter in many calls when call quiz questionnaire controller.<br /> <br /> =====Remove Unnecessary Checks=====<br /> <br /> In few methods like save_questions checks like “@questionnaire.id if !@questionnaire.id.nil? and @questionnaire.id &gt; 0” are added. These kind of checks are unnecessary because since value of questionnaire.id will be present is @questionnaire class variable. To clear up such code we have removed unnecessary check. <br /> <br /> =====Update Questionnaire Spec=====<br /> <br /> As mentioned in US2, we have removed create_questionnaire method and we have also removed corresponding test of that method in spec file. Rest no changes were done in spec file. We had run the tests before and after refactoring and they have passed. <br /> <br /> =====Update Quiz Questionnaire Spec=====<br /> <br /> As mentioned in US3 we have removed unnecessary variables, one of the variable was questionnaire_id which was just params[:id]. This variable was passed as parameter in many of quiz questionnaire methods. we have removed this variable and method calls are changed. We have changed test cases also of all the corresponding method.<br /> <br /> ==Test Plan==<br /> <br /> Our test plan is to create or existing test cases for all the user stories we have created and run it as soon as we are completing the user story. For most of our changes we did not have to create new test cases but we have modified exiting test cases for all the functionalities that we have been modifying. We have made changes in 2 spec file and have run the test cases. <br /> <br /> Below is the screenshot of the result after running the test cases.<br /> <br /> [[File:test.jpeg]]<br /> <br /> ==LoopHoles== <br /> <br /> * In several places begin and rescue statement are used without properly understanding the functionality. Due to this critical error messages are lost and debugging those error would be difficult. To fix this proper error log is added and begin rescue is removed.<br /> * On editing any questionnaire, they are not getting updated. Values are being hardcoded at backend and questionnaire never gets updated. Issue#1550 has been created to fix this bug.<br /> <br /> ==Team==<br /> =====Mentor===== <br /> Prof. Edward Gehringer<br /> =====Members===== <br /> * Garima Garima, Ggarima<br /> * Bharat Bhardwaj, Bbhardw<br /> * Piyush Tiwari, Ptiwari<br /> <br /> ==References==<br /> <br /> #[https://expertiza.ncsu.edu/ Expertiza]<br /> #[https://github.com/expertiza/expertiza Expertiza GitHub]<br /> #[https://github.com/piyushtiw/expertiza/pull/14 Pull Request to Merge]<br /> #[http://152.7.98.234:8080/ Deployed Changes Userid - instructor6 and Password - password]<br /> #[https://github.com/piyushtiw/expertiza/projects/2 GitHub Project Board]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-_E1946._Refactor_Questionnaire_controller&diff=126997 2019-11-03T20:12:03Z

<p>Ggarima: </p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> __TOC__<br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==About Questionnaire Controller==<br /> <br /> Questionnaire is the superclass for all kinds of questionnaires and rubrics, rubrics is used for evaluating submissions and teammate contributions, and taking quizzes and surveys. All of these are subclasses of Questionnaire. This controller is used for creating, displaying, and managing Questionnaires. Different type of questionnaire can be created in Expertiza like Review, Metareview, Teammate review, Quiz Questionnaire, Global Survey, Course Survey and many more. This Controller is widely used and malfunctions can cause many issues in different parts of the system.<br /> <br /> Below is screenshot of questionnaire on expertiza. It shows all the kinds of questionnaire we can create on expertiza. <br /> <br /> [[File:Questionnaire_1.png]]<br /> <br /> Below is screenshot of all the review questionnaire we have created till now. We can edit, delete and do many other operations on questionnaire.<br /> <br /> [[File:Questionnaire_view.png]]<br /> <br /> Below is screenshot which shows how we can edit any questionnaire. <br /> <br /> [[File:Questionnaire_edit_3.png]]<br /> <br /> ==Why Refactor Questionnaire Controller==<br /> <br /> In Questionnaire controller below are some of the problems which needs refactoring: <br /> <br /> * Renaming the methods breaking Rubys naming conventions. <br /> * Refactoring the methods doing multiple tasks and breaking them in different modules.<br /> * Reducing the length of methods longer than 50 lines of code.<br /> * Removing the string literal values used in controller.<br /> * Separating the business logic from controller and putting it in method.<br /> * Remove variables behaving same as ruby's given functionality.<br /> * Commenting the code properly for easy understanding.<br /> <br /> ==Files Modified==<br /> <br /> Below are the five file we changed as part of refactoring<br /> <br /> =====Questionnaire Controller===== <br /> This is the questionnaires_controller.rb which handles all the CRUD operation performed on any kind of questionnaire - review or surveys, add weightage to all questions, selecting type of questions. This controller holds the major part of work done for creating questions. Creating of questionnaire was one method which was extremely complicated and not well commented about what is going on. Multiple things were done in just one method which we broke in modules doing that specific task. This controller was holding the business logic as well, which we can move to model. Variables were created separate to get value from UI. At many places string literals were being hardcoded, which were made as constants.<br /> =====Questionnaire Model=====<br /> This is the questionnaire.rb model file and we have added self method in it, which will create questionnaire object for us and we will get that object in controller and process it in controller. <br /> =====Questionnaire Spec=====<br /> This is the questionnaire_controller_spec.rb file and we have changed this file in order to test the changes we have made in Questionnaire controller.<br /> =====Quiz Questionnaire Controller=====<br /> This file is quiz_questionnaire_controller.rb and was calling multiple methods of quiz questionnaire by passing questionnaire id as parameter which we have removed. <br /> =====Quiz Questionnaire Spec=====<br /> This is quiz_questionnaire_spec.rb was changed as we have removed questionnaire ID from methods in Quiz Questionnaire controller.<br /> <br /> ==User Stories==<br /> <br /> We have used Github project board to keep track of work that needs to be refactored. Below were the user stories that we have created: <br /> <br /> * '''US1''' - As a developer i want to analyse create questionnaire so that i can refactor and break it into modules.<br /> * '''US2''' - As a developer i want to refactor the create_questionnaire method by giving it meaningful name and improving code so that it does not conflict with ruby naming standard.<br /> * '''US3''' - As a developer i want to remove questionnaire_id with params[:id] so that we can remove unnecessary variables.<br /> * '''US4''' - As a developer i want to remove all hardcoded values of alternatives, min label and max label and put them in literals, so that code can be aligned to coding standards.<br /> * '''US5''' - As a developer i want to analyse why Questionnaire is being checked as QuizQuestionnaire multiple times and functionality is being changed, so that we can make quiz questionnaire same as rest.<br /> * '''US6''' - As a developer i want to analyse why questionnaire_id has been passed as parameter in many question so that i can refactor the code.<br /> * '''US7''' - As a developer i want to run rspecs in Questionnaire spec to so that i can make sure the changes made are working correct.<br /> * '''US8''' - As a developer i want to run rspecs in Quiz Questionnaire spec to so that i can make sure the changes made are working correct.<br /> <br /> ==Refactoring==<br /> <br /> =====Refactor Create Method===== <br /> This method was in questionnaires_controller.rb<br /> Create method was very long in Questionnaire controller and was not self explanatory, number of characters in one line is more than 80 and cant be seen in one window.<br /> '''Before Refactoring'''<br /> &lt;pre&gt;<br /> def create<br /> if params[:questionnaire][:name].blank?<br /> flash[:error] = 'A rubric or survey must have a title.'<br /> redirect_to controller: 'questionnaires', action: 'new', model: params[:questionnaire][:type], private: params[:questionnaire][:private]<br /> else<br /> questionnaire_private = params[:questionnaire][:private] == 'true'<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> begin<br /> @questionnaire = Object.const_get(params[:questionnaire][:type]).new if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> begin<br /> @questionnaire.private = questionnaire_private<br /> @questionnaire.name = params[:questionnaire][:name]<br /> @questionnaire.instructor_id = session[:user].id<br /> @questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> @questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> @questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> # E1903 : We are not sure of other type of cases, so have added a if statement. If there are only 5 cases, remove the if statement<br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> @questionnaire.display_type = display_type<br /> @questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> @questionnaire.save<br /> # Create node<br /> tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')<br /> flash[:success] = 'You have successfully created a questionnaire!'<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> In this user story we created self method in questionnaire model which will create questionnaire object and pass it in controller. Self method was divided in to two different modules which we then called into self. <br /> <br /> Method create_questionnaire_node(questionnaire) - This method will create a Tree node for new questionnaire in Expertiza&lt;br/&gt;<br /> &lt;pre&gt;<br /> # This method is used to create Treenode for newly created questionnaire<br /> def create_questionnaire_node(questionnaire)<br /> tree_folder = TreeFolder.where(['name like ?', questionnaire.display_type]).first<br /> <br /> if tree_folder.present?<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: questionnaire.id, type: 'QuestionnaireNode')<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> Method display_type_for_questionnaire(params) - This method will tell us about display type for new questionnaire in Expertiza&lt;br/&gt;<br /> <br /> &lt;pre&gt;<br /> # Displaying the newly created questionnaire<br /> def display_type_for_questionnaire(params)<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> <br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> <br /> display_type<br /> end<br /> &lt;/pre&gt;<br /> <br /> This method below will be the main method for creating the questionnaire object and will call the two method we have written above. <br /> Self - Assigning all variable values from UI into questionnaire object + create_questionnaire_node(questionnaire) + display_type_for_questionnaire(params)<br /> <br /> &lt;pre&gt;<br /> # This method will create a questionnaire object and will be called from controller. <br /> class &lt;&lt; self<br /> def create_new_questionnaire_obj(params, session)<br /> # Assigning values passed from UI in params[:id] to questionnaire object<br /> if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> questionnaire = Object.const_get(params[:questionnaire][:type]).new <br /> questionnaire.private = params[:questionnaire][:private] == 'true'<br /> questionnaire.name = params[:questionnaire][:name]<br /> questionnaire.instructor_id = session[:user].id<br /> questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> questionnaire.display_type = display_type_for_questionnaire(params)<br /> questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> <br /> if questionnaire.save<br /> create_questionnaire_node(questionnaire)<br /> end<br /> # returning the questionnaire object to calling method create in controller<br /> questionnaire<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Refactor Create Questionnaire Method===== <br /> <br /> This method was in questionnaires_controller.rb and in this user story after deep analysis of create_questionnaire method, we found that this method has not been called anywhere so we have '''removed''' this method from the questionnaire controller. <br /> <br /> =====Remove Unnecessary Variables=====<br /> <br /> As a part of this user story we have removed unnecessary variables in questionnaires_controller.rb file. In this file methods like add_new_questions, save_all_questions, save_questions, save_new_questions, delete_questions, local variable questionnaire_id was passed as a method argument which is not actually required since this value can be fetched from class variable @questionnaire.id or from params[:id]. So, this variable was unnecessary. Below is the one of the methods named save_all_questions which was using questionnaire_id as method parameter and we refactored.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to save all questions in current questionnaire.<br /> def save_all_questions<br /> questionnaire_id = params[:id]<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif !questionnaire_id.nil?<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> &lt;pre&gt;<br /> def save_all_questions<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif params[:id].present?<br /> redirect_to edit_questionnaire_path(params[:id])<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Hardcoded String Literals=====<br /> <br /> As a part of this user story we have made changes in questionnaires_controller.rb file. Few methods have values directly hardcoded in code, which does not justify good coding standard. To clean up this code we used constant variables which also clearly mention what value is being set by this variable. Refactoring was done in method like add_new_questions.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> questionnaire_id = params[:id] unless params[:id].nil?<br /> num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size<br /> ((num_of_existed_questions + 1)..(num_of_existed_questions + params[:question][:total_num].to_i)).each do |i|<br /> question = Object.const_get(params[:question][:type]).create(txt: '', questionnaire_id: questionnaire_id, seq: i, type: params[:question][:type], break_before: true)<br /> if question.is_a? ScoredQuestion<br /> question.weight = 1<br /> question.max_label = 'Strongly agree'<br /> question.min_label = 'Strongly disagree'<br /> end<br /> question.size = '50, 3' if question.is_a? Criterion<br /> question.alternatives = '0|1|2|3|4|5' if question.is_a? Dropdown<br /> question.size = '60, 5' if question.is_a? TextArea<br /> question.size = '30' if question.is_a? TextField<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> Constants created were: <br /> <br /> &lt;pre&gt;<br /> QUESTION_MIN_SCORE = 0<br /> QUESTION_MAX_SCORE = 1<br /> QUESTION_MAX_LABEL = 'Strongly agree'<br /> QUESTION_MIN_LABEL = 'Strongly disagree'<br /> QUESTION_CRITERION_SIZE = '50, 3'<br /> DROPDOWN_SCALE = '0|1|2|3|4|5'<br /> TEXT_AREA_SIZE = '60, 5'<br /> TEXT_FIELD_SIZE = '30'<br /> &lt;/pre&gt;<br /> <br /> We refactored the above method by making the constants and using them instead of just passing literals. We have also improved the logic by using the better conditions and variables in method.<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> num_of_existed_questions = Questionnaire.find(params[:id]).questions.size<br /> question_nums =params[:question][:total_num].to_i<br /> total_question_nums = ((num_of_existed_questions + 1)..(num_of_existed_questions + question_nums))<br /> <br /> total_question_nums.each do |i|<br /> question = Object.const_get(params[:question][:type]).create(<br /> txt: '',<br /> questionnaire_id: params[:id],<br /> seq: i,<br /> type: params[:question][:type],<br /> break_before: true<br /> )<br /> if question.is_a? ScoredQuestion<br /> question.weight = MAXIMUM_QUESTION_SCORE<br /> question.min_label = QUESTION_MIN_LABEL<br /> question.max_label = QUESTION_MAX_LABEL<br /> end<br /> <br /> question.alternatives = DROPDOWN_SCALE if question.is_a? Dropdown<br /> question.size = question_size(question)<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(params[:id].to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Unnecessary Parameters =====<br /> <br /> This change was done in Quiz_questionnaire.rb file. Questionnaire_id is the variable which has value of params[:id], this variable was passed as method parameter in many calls when call quiz questionnaire controller.<br /> <br /> =====Remove Unnecessary Checks=====<br /> <br /> In few methods like save_questions checks like “@questionnaire.id if !@questionnaire.id.nil? and @questionnaire.id &gt; 0” are added. These kind of checks are unnecessary because since value of questionnaire.id will be present is @questionnaire class variable. To clear up such code we have removed unnecessary check. <br /> <br /> =====Update Questionnaire Spec=====<br /> <br /> As mentioned in US2, we have removed create_questionnaire method and we have also removed corresponding test of that method in spec file. Rest no changes were done in spec file. We had run the tests before and after refactoring and they have passed. <br /> <br /> =====Update Quiz Questionnaire Spec=====<br /> <br /> As mentioned in US3 we have removed unnecessary variables, one of the variable was questionnaire_id which was just params[:id]. This variable was passed as parameter in many of quiz questionnaire methods. we have removed this variable and method calls are changed. We have changed test cases also of all the corresponding method.<br /> <br /> ==Test Plan==<br /> <br /> Our test plan is to create or existing test cases for all the user stories we have created and run it as soon as we are completing the user story. For most of our changes we did not have to create new test cases but we have modified exiting test cases for all the functionalities that we have been modifying. We have made changes in 2 spec file and have run the test cases. <br /> <br /> Below is the screenshot of the result after running the test cases.<br /> <br /> [[File:test.jpeg]]<br /> <br /> ==LoopHoles== <br /> <br /> * In several places begin and rescue statement are used without properly understanding the functionality. Due to this critical error messages are lost and debugging those error would be difficult. To fix this proper error log is added and begin rescue is removed.<br /> * On editing any questionnaire, they are not getting updated. Values are being hardcoded at backend and questionnaire never gets updated. Issue#1550 has been created to fix this bug.<br /> <br /> ==Team==<br /> =====Mentor===== <br /> Prof. Edward Gehringer<br /> =====Members===== <br /> * Garima Garima, Ggarima<br /> * Bharat Bhardwaj, Bbhardw<br /> * Piyush Tiwari, Ptiwari<br /> <br /> ==References==<br /> <br /> #[https://expertiza.ncsu.edu/ Expertiza]<br /> #[https://github.com/expertiza/expertiza Expertiza GitHub]<br /> #[https://github.com/piyushtiw/expertiza/pull/14/files#diff-b41fa84d1ee0c03c4e301f977fbe453d Pull Request to Merge]<br /> #[http://152.7.98.234:8080/ Deployed Changes Userid - instructor6 and Password - password]<br /> #[https://github.com/piyushtiw/expertiza/projects/2 GitHub Project Board]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-_E1946._Refactor_Questionnaire_controller&diff=126996 2019-11-03T20:10:31Z

<p>Ggarima: </p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> <br /> __TOC__<br /> <br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==About Questionnaire Controller==<br /> <br /> Questionnaire is the superclass for all kinds of questionnaires and rubrics, rubrics is used for evaluating submissions and teammate contributions, and taking quizzes and surveys. All of these are subclasses of Questionnaire. This controller is used for creating, displaying, and managing Questionnaires. Different type of questionnaire can be created in Expertiza like Review, Metareview, Teammate review, Quiz Questionnaire, Global Survey, Course Survey and many more. This Controller is widely used and malfunctions can cause many issues in different parts of the system.<br /> <br /> Below is screenshot of questionnaire on expertiza. It shows all the kinds of questionnaire we can create on expertiza. <br /> <br /> [[File:Questionnaire_1.png]]<br /> <br /> Below is screenshot of all the review questionnaire we have created till now. We can edit, delete and do many other operations on questionnaire.<br /> <br /> [[File:Questionnaire_view.png]]<br /> <br /> Below is screenshot which shows how we can edit any questionnaire. <br /> <br /> [[File:Questionnaire_edit_3.png]]<br /> <br /> ==Why Refactor Questionnaire Controller==<br /> <br /> In Questionnaire controller below are some of the problems which needs refactoring: <br /> <br /> * Renaming the methods breaking Rubys naming conventions. <br /> * Refactoring the methods doing multiple tasks and breaking them in different modules.<br /> * Reducing the length of methods longer than 50 lines of code.<br /> * Removing the string literal values used in controller.<br /> * Separating the business logic from controller and putting it in method.<br /> * Remove variables behaving same as ruby's given functionality.<br /> * Commenting the code properly for easy understanding.<br /> <br /> ==Files Modified==<br /> <br /> Below are the five file we changed as part of refactoring<br /> <br /> =====Questionnaire Controller===== <br /> This is the questionnaires_controller.rb which handles all the CRUD operation performed on any kind of questionnaire - review or surveys, add weightage to all questions, selecting type of questions. This controller holds the major part of work done for creating questions. Creating of questionnaire was one method which was extremely complicated and not well commented about what is going on. Multiple things were done in just one method which we broke in modules doing that specific task. This controller was holding the business logic as well, which we can move to model. Variables were created separate to get value from UI. At many places string literals were being hardcoded, which were made as constants.<br /> =====Questionnaire Model=====<br /> This is the questionnaire.rb model file and we have added self method in it, which will create questionnaire object for us and we will get that object in controller and process it in controller. <br /> =====Questionnaire Spec=====<br /> This is the questionnaire_controller_spec.rb file and we have changed this file in order to test the changes we have made in Questionnaire controller.<br /> =====Quiz Questionnaire Controller=====<br /> This file is quiz_questionnaire_controller.rb and was calling multiple methods of quiz questionnaire by passing questionnaire id as parameter which we have removed. <br /> =====Quiz Questionnaire Spec=====<br /> This is quiz_questionnaire_spec.rb was changed as we have removed questionnaire ID from methods in Quiz Questionnaire controller.<br /> <br /> ==User Stories==<br /> <br /> We have used Github project board to keep track of work that needs to be refactored. Below were the user stories that we have created: <br /> <br /> * '''US1''' - As a developer i want to analyse create questionnaire so that i can refactor and break it into modules.<br /> * '''US2''' - As a developer i want to refactor the create_questionnaire method by giving it meaningful name and improving code so that it does not conflict with ruby naming standard.<br /> * '''US3''' - As a developer i want to remove questionnaire_id with params[:id] so that we can remove unnecessary variables.<br /> * '''US4''' - As a developer i want to remove all hardcoded values of alternatives, min label and max label and put them in literals, so that code can be aligned to coding standards.<br /> * '''US5''' - As a developer i want to analyse why Questionnaire is being checked as QuizQuestionnaire multiple times and functionality is being changed, so that we can make quiz questionnaire same as rest.<br /> * '''US6''' - As a developer i want to analyse why questionnaire_id has been passed as parameter in many question so that i can refactor the code.<br /> * '''US7''' - As a developer i want to run rspecs in Questionnaire spec to so that i can make sure the changes made are working correct.<br /> * '''US8''' - As a developer i want to run rspecs in Quiz Questionnaire spec to so that i can make sure the changes made are working correct.<br /> <br /> ==Refactoring==<br /> <br /> =====Refactor Create Method===== <br /> This method was in questionnaires_controller.rb<br /> Create method was very long in Questionnaire controller and was not self explanatory, number of characters in one line is more than 80 and cant be seen in one window.<br /> '''Before Refactoring'''<br /> &lt;pre&gt;<br /> def create<br /> if params[:questionnaire][:name].blank?<br /> flash[:error] = 'A rubric or survey must have a title.'<br /> redirect_to controller: 'questionnaires', action: 'new', model: params[:questionnaire][:type], private: params[:questionnaire][:private]<br /> else<br /> questionnaire_private = params[:questionnaire][:private] == 'true'<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> begin<br /> @questionnaire = Object.const_get(params[:questionnaire][:type]).new if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> begin<br /> @questionnaire.private = questionnaire_private<br /> @questionnaire.name = params[:questionnaire][:name]<br /> @questionnaire.instructor_id = session[:user].id<br /> @questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> @questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> @questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> # E1903 : We are not sure of other type of cases, so have added a if statement. If there are only 5 cases, remove the if statement<br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> @questionnaire.display_type = display_type<br /> @questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> @questionnaire.save<br /> # Create node<br /> tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')<br /> flash[:success] = 'You have successfully created a questionnaire!'<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> In this user story we created self method in questionnaire model which will create questionnaire object and pass it in controller. Self method was divided in to two different modules which we then called into self. <br /> <br /> Method create_questionnaire_node(questionnaire) - This method will create a Tree node for new questionnaire in Expertiza&lt;br/&gt;<br /> &lt;pre&gt;<br /> # This method is used to create Treenode for newly created questionnaire<br /> def create_questionnaire_node(questionnaire)<br /> tree_folder = TreeFolder.where(['name like ?', questionnaire.display_type]).first<br /> <br /> if tree_folder.present?<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: questionnaire.id, type: 'QuestionnaireNode')<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> Method display_type_for_questionnaire(params) - This method will tell us about display type for new questionnaire in Expertiza&lt;br/&gt;<br /> <br /> &lt;pre&gt;<br /> # Displaying the newly created questionnaire<br /> def display_type_for_questionnaire(params)<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> <br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> <br /> display_type<br /> end<br /> &lt;/pre&gt;<br /> <br /> This method below will be the main method for creating the questionnaire object and will call the two method we have written above. <br /> Self - Assigning all variable values from UI into questionnaire object + create_questionnaire_node(questionnaire) + display_type_for_questionnaire(params)<br /> <br /> &lt;pre&gt;<br /> # This method will create a questionnaire object and will be called from controller. <br /> class &lt;&lt; self<br /> def create_new_questionnaire_obj(params, session)<br /> # Assigning values passed from UI in params[:id] to questionnaire object<br /> if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> questionnaire = Object.const_get(params[:questionnaire][:type]).new <br /> questionnaire.private = params[:questionnaire][:private] == 'true'<br /> questionnaire.name = params[:questionnaire][:name]<br /> questionnaire.instructor_id = session[:user].id<br /> questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> questionnaire.display_type = display_type_for_questionnaire(params)<br /> questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> <br /> if questionnaire.save<br /> create_questionnaire_node(questionnaire)<br /> end<br /> # returning the questionnaire object to calling method create in controller<br /> questionnaire<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Refactor Create Questionnaire Method===== <br /> <br /> This method was in questionnaires_controller.rb and in this user story after deep analysis of create_questionnaire method, we found that this method has not been called anywhere so we have '''removed''' this method from the questionnaire controller. <br /> <br /> =====Remove Unnecessary Variables=====<br /> <br /> As a part of this user story we have removed unnecessary variables in questionnaires_controller.rb file. In this file methods like add_new_questions, save_all_questions, save_questions, save_new_questions, delete_questions, local variable questionnaire_id was passed as a method argument which is not actually required since this value can be fetched from class variable @questionnaire.id or from params[:id]. So, this variable was unnecessary. Below is the one of the methods named save_all_questions which was using questionnaire_id as method parameter and we refactored.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to save all questions in current questionnaire.<br /> def save_all_questions<br /> questionnaire_id = params[:id]<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif !questionnaire_id.nil?<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> &lt;pre&gt;<br /> def save_all_questions<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif params[:id].present?<br /> redirect_to edit_questionnaire_path(params[:id])<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Hardcoded String Literals=====<br /> <br /> As a part of this user story we have made changes in questionnaires_controller.rb file. Few methods have values directly hardcoded in code, which does not justify good coding standard. To clean up this code we used constant variables which also clearly mention what value is being set by this variable. Refactoring was done in method like add_new_questions.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> questionnaire_id = params[:id] unless params[:id].nil?<br /> num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size<br /> ((num_of_existed_questions + 1)..(num_of_existed_questions + params[:question][:total_num].to_i)).each do |i|<br /> question = Object.const_get(params[:question][:type]).create(txt: '', questionnaire_id: questionnaire_id, seq: i, type: params[:question][:type], break_before: true)<br /> if question.is_a? ScoredQuestion<br /> question.weight = 1<br /> question.max_label = 'Strongly agree'<br /> question.min_label = 'Strongly disagree'<br /> end<br /> question.size = '50, 3' if question.is_a? Criterion<br /> question.alternatives = '0|1|2|3|4|5' if question.is_a? Dropdown<br /> question.size = '60, 5' if question.is_a? TextArea<br /> question.size = '30' if question.is_a? TextField<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> Constants created were: <br /> <br /> &lt;pre&gt;<br /> QUESTION_MIN_SCORE = 0<br /> QUESTION_MAX_SCORE = 1<br /> QUESTION_MAX_LABEL = 'Strongly agree'<br /> QUESTION_MIN_LABEL = 'Strongly disagree'<br /> QUESTION_CRITERION_SIZE = '50, 3'<br /> DROPDOWN_SCALE = '0|1|2|3|4|5'<br /> TEXT_AREA_SIZE = '60, 5'<br /> TEXT_FIELD_SIZE = '30'<br /> &lt;/pre&gt;<br /> <br /> We refactored the above method by making the constants and using them instead of just passing literals. We have also improved the logic by using the better conditions and variables in method.<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> num_of_existed_questions = Questionnaire.find(params[:id]).questions.size<br /> question_nums =params[:question][:total_num].to_i<br /> total_question_nums = ((num_of_existed_questions + 1)..(num_of_existed_questions + question_nums))<br /> <br /> total_question_nums.each do |i|<br /> question = Object.const_get(params[:question][:type]).create(<br /> txt: '',<br /> questionnaire_id: params[:id],<br /> seq: i,<br /> type: params[:question][:type],<br /> break_before: true<br /> )<br /> if question.is_a? ScoredQuestion<br /> question.weight = MAXIMUM_QUESTION_SCORE<br /> question.min_label = QUESTION_MIN_LABEL<br /> question.max_label = QUESTION_MAX_LABEL<br /> end<br /> <br /> question.alternatives = DROPDOWN_SCALE if question.is_a? Dropdown<br /> question.size = question_size(question)<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(params[:id].to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Unnecessary Parameters =====<br /> <br /> This change was done in Quiz_questionnaire.rb file. Questionnaire_id is the variable which has value of params[:id], this variable was passed as method parameter in many calls when call quiz questionnaire controller.<br /> <br /> =====Remove Unnecessary Checks=====<br /> <br /> In few methods like save_questions checks like “@questionnaire.id if !@questionnaire.id.nil? and @questionnaire.id &gt; 0” are added. These kind of checks are unnecessary because since value of questionnaire.id will be present is @questionnaire class variable. To clear up such code we have removed unnecessary check. <br /> <br /> =====Update Questionnaire Spec=====<br /> <br /> As mentioned in US2, we have removed create_questionnaire method and we have also removed corresponding test of that method in spec file. Rest no changes were done in spec file. We had run the tests before and after refactoring and they have passed. <br /> <br /> =====Update Quiz Questionnaire Spec=====<br /> <br /> As mentioned in US3 we have removed unnecessary variables, one of the variable was questionnaire_id which was just params[:id]. This variable was passed as parameter in many of quiz questionnaire methods. we have removed this variable and method calls are changed. We have changed test cases also of all the corresponding method.<br /> <br /> ==Test Plan==<br /> <br /> Our test plan is to create or existing test cases for all the user stories we have created and run it as soon as we are completing the user story. For most of our changes we did not have to create new test cases but we have modified exiting test cases for all the functionalities that we have been modifying. We have made changes in 2 spec file and have run the test cases. <br /> <br /> Below is the screenshot of the result after running the test cases.<br /> <br /> [[File:test.jpeg]]<br /> <br /> ==LoopHoles== <br /> <br /> * In several places begin and rescue statement are used without properly understanding the functionality. Due to this critical error messages are lost and debugging those error would be difficult. To fix this proper error log is added and begin rescue is removed.<br /> * On editing any questionnaire, they are not getting updated. Values are being hardcoded at backend and questionnaire never gets updated. Issue#1550 has been created to fix this bug.<br /> <br /> ==Team==<br /> =====Mentor===== <br /> Prof. Edward Gehringer<br /> =====Members===== <br /> * Garima Garima, Ggarima<br /> * Bharat Bhardwaj, Bbhardw<br /> * Piyush Tiwari, Ptiwari<br /> <br /> ==References==<br /> <br /> #[https://expertiza.ncsu.edu/ Expertiza]<br /> #[https://github.com/expertiza/expertiza Expertiza GitHub]<br /> #[https://github.com/piyushtiw/expertiza/pull/14/files#diff-b41fa84d1ee0c03c4e301f977fbe453d Pull Request to Merge]<br /> #[http://152.7.98.234:8080/ Deployed Changes Userid - instructor6 and Password - password]<br /> #[https://github.com/piyushtiw/expertiza/projects/2 GitHub Project Board]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=File:Test.jpeg&diff=126995 2019-11-03T20:10:00Z

<p>Ggarima: </p> <hr /> <div></div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-_E1946._Refactor_Questionnaire_controller&diff=126994 2019-11-03T20:02:44Z

<p>Ggarima: </p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> <br /> __TOC__<br /> <br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==About Questionnaire Controller==<br /> <br /> Questionnaire is the superclass for all kinds of questionnaires and rubrics, rubrics is used for evaluating submissions and teammate contributions, and taking quizzes and surveys. All of these are subclasses of Questionnaire. This controller is used for creating, displaying, and managing Questionnaires. Different type of questionnaire can be created in Expertiza like Review, Metareview, Teammate review, Quiz Questionnaire, Global Survey, Course Survey and many more. This Controller is widely used and malfunctions can cause many issues in different parts of the system.<br /> <br /> Below is screenshot of questionnaire on expertiza. It shows all the kinds of questionnaire we can create on expertiza. <br /> <br /> [[File:Questionnaire_1.png]]<br /> <br /> Below is screenshot of all the review questionnaire we have created till now. We can edit, delete and do many other operations on questionnaire.<br /> <br /> [[File:Questionnaire_view.png]]<br /> <br /> Below is screenshot which shows how we can edit any questionnaire. <br /> <br /> [[File:Questionnaire_edit_3.png]]<br /> <br /> ==Why Refactor Questionnaire Controller==<br /> <br /> In Questionnaire controller below are some of the problems which needs refactoring: <br /> <br /> * Renaming the methods breaking Rubys naming conventions. <br /> * Refactoring the methods doing multiple tasks and breaking them in different modules.<br /> * Reducing the length of methods longer than 50 lines of code.<br /> * Removing the string literal values used in controller.<br /> * Separating the business logic from controller and putting it in method.<br /> * Remove variables behaving same as ruby's given functionality.<br /> * Commenting the code properly for easy understanding.<br /> <br /> ==Files Modified==<br /> <br /> Below are the five file we changed as part of refactoring<br /> <br /> =====Questionnaire Controller===== <br /> This is the questionnaires_controller.rb which handles all the CRUD operation performed on any kind of questionnaire - review or surveys, add weightage to all questions, selecting type of questions. This controller holds the major part of work done for creating questions. Creating of questionnaire was one method which was extremely complicated and not well commented about what is going on. Multiple things were done in just one method which we broke in modules doing that specific task. This controller was holding the business logic as well, which we can move to model. Variables were created separate to get value from UI. At many places string literals were being hardcoded, which were made as constants.<br /> =====Questionnaire Model=====<br /> This is the questionnaire.rb model file and we have added self method in it, which will create questionnaire object for us and we will get that object in controller and process it in controller. <br /> =====Questionnaire Spec=====<br /> This is the questionnaire_controller_spec.rb file and we have changed this file in order to test the changes we have made in Questionnaire controller.<br /> =====Quiz Questionnaire Controller=====<br /> This file is quiz_questionnaire_controller.rb and was calling multiple methods of quiz questionnaire by passing questionnaire id as parameter which we have removed. <br /> =====Quiz Questionnaire Spec=====<br /> This is quiz_questionnaire_spec.rb was changed as we have removed questionnaire ID from methods in Quiz Questionnaire controller.<br /> <br /> ==User Stories==<br /> <br /> We have used Github project board to keep track of work that needs to be refactored. Below were the user stories that we have created: <br /> <br /> * '''US1''' - As a developer i want to analyse create questionnaire so that i can refactor and break it into modules.<br /> * '''US2''' - As a developer i want to refactor the create_questionnaire method by giving it meaningful name and improving code so that it does not conflict with ruby naming standard.<br /> * '''US3''' - As a developer i want to remove questionnaire_id with params[:id] so that we can remove unnecessary variables.<br /> * '''US4''' - As a developer i want to remove all hardcoded values of alternatives, min label and max label and put them in literals, so that code can be aligned to coding standards.<br /> * '''US5''' - As a developer i want to analyse why Questionnaire is being checked as QuizQuestionnaire multiple times and functionality is being changed, so that we can make quiz questionnaire same as rest.<br /> * '''US6''' - As a developer i want to analyse why questionnaire_id has been passed as parameter in many question so that i can refactor the code.<br /> * '''US7''' - As a developer i want to run rspecs in Questionnaire spec to so that i can make sure the changes made are working correct.<br /> * '''US8''' - As a developer i want to run rspecs in Quiz Questionnaire spec to so that i can make sure the changes made are working correct.<br /> <br /> ==Refactoring==<br /> <br /> =====Refactor Create Method===== <br /> This method was in questionnaires_controller.rb<br /> Create method was very long in Questionnaire controller and was not self explanatory, number of characters in one line is more than 80 and cant be seen in one window.<br /> '''Before Refactoring'''<br /> &lt;pre&gt;<br /> def create<br /> if params[:questionnaire][:name].blank?<br /> flash[:error] = 'A rubric or survey must have a title.'<br /> redirect_to controller: 'questionnaires', action: 'new', model: params[:questionnaire][:type], private: params[:questionnaire][:private]<br /> else<br /> questionnaire_private = params[:questionnaire][:private] == 'true'<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> begin<br /> @questionnaire = Object.const_get(params[:questionnaire][:type]).new if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> begin<br /> @questionnaire.private = questionnaire_private<br /> @questionnaire.name = params[:questionnaire][:name]<br /> @questionnaire.instructor_id = session[:user].id<br /> @questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> @questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> @questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> # E1903 : We are not sure of other type of cases, so have added a if statement. If there are only 5 cases, remove the if statement<br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> @questionnaire.display_type = display_type<br /> @questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> @questionnaire.save<br /> # Create node<br /> tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')<br /> flash[:success] = 'You have successfully created a questionnaire!'<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> In this user story we created self method in questionnaire model which will create questionnaire object and pass it in controller. Self method was divided in to two different modules which we then called into self. <br /> <br /> Method create_questionnaire_node(questionnaire) - This method will create a Tree node for new questionnaire in Expertiza&lt;br/&gt;<br /> &lt;pre&gt;<br /> # This method is used to create Treenode for newly created questionnaire<br /> def create_questionnaire_node(questionnaire)<br /> tree_folder = TreeFolder.where(['name like ?', questionnaire.display_type]).first<br /> <br /> if tree_folder.present?<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: questionnaire.id, type: 'QuestionnaireNode')<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> Method display_type_for_questionnaire(params) - This method will tell us about display type for new questionnaire in Expertiza&lt;br/&gt;<br /> <br /> &lt;pre&gt;<br /> # Displaying the newly created questionnaire<br /> def display_type_for_questionnaire(params)<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> <br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> <br /> display_type<br /> end<br /> &lt;/pre&gt;<br /> <br /> This method below will be the main method for creating the questionnaire object and will call the two method we have written above. <br /> Self - Assigning all variable values from UI into questionnaire object + create_questionnaire_node(questionnaire) + display_type_for_questionnaire(params)<br /> <br /> &lt;pre&gt;<br /> # This method will create a questionnaire object and will be called from controller. <br /> class &lt;&lt; self<br /> def create_new_questionnaire_obj(params, session)<br /> # Assigning values passed from UI in params[:id] to questionnaire object<br /> if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> questionnaire = Object.const_get(params[:questionnaire][:type]).new <br /> questionnaire.private = params[:questionnaire][:private] == 'true'<br /> questionnaire.name = params[:questionnaire][:name]<br /> questionnaire.instructor_id = session[:user].id<br /> questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> questionnaire.display_type = display_type_for_questionnaire(params)<br /> questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> <br /> if questionnaire.save<br /> create_questionnaire_node(questionnaire)<br /> end<br /> # returning the questionnaire object to calling method create in controller<br /> questionnaire<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Refactor Create Questionnaire Method===== <br /> <br /> This method was in questionnaires_controller.rb and in this user story after deep analysis of create_questionnaire method, we found that this method has not been called anywhere so we have '''removed''' this method from the questionnaire controller. <br /> <br /> =====Remove Unnecessary Variables=====<br /> <br /> As a part of this user story we have removed unnecessary variables in questionnaires_controller.rb file. In this file methods like add_new_questions, save_all_questions, save_questions, save_new_questions, delete_questions, local variable questionnaire_id was passed as a method argument which is not actually required since this value can be fetched from class variable @questionnaire.id or from params[:id]. So, this variable was unnecessary. Below is the one of the methods named save_all_questions which was using questionnaire_id as method parameter and we refactored.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to save all questions in current questionnaire.<br /> def save_all_questions<br /> questionnaire_id = params[:id]<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif !questionnaire_id.nil?<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> &lt;pre&gt;<br /> def save_all_questions<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif params[:id].present?<br /> redirect_to edit_questionnaire_path(params[:id])<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Hardcoded String Literals=====<br /> <br /> As a part of this user story we have made changes in questionnaires_controller.rb file. Few methods have values directly hardcoded in code, which does not justify good coding standard. To clean up this code we used constant variables which also clearly mention what value is being set by this variable. Refactoring was done in method like add_new_questions.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> questionnaire_id = params[:id] unless params[:id].nil?<br /> num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size<br /> ((num_of_existed_questions + 1)..(num_of_existed_questions + params[:question][:total_num].to_i)).each do |i|<br /> question = Object.const_get(params[:question][:type]).create(txt: '', questionnaire_id: questionnaire_id, seq: i, type: params[:question][:type], break_before: true)<br /> if question.is_a? ScoredQuestion<br /> question.weight = 1<br /> question.max_label = 'Strongly agree'<br /> question.min_label = 'Strongly disagree'<br /> end<br /> question.size = '50, 3' if question.is_a? Criterion<br /> question.alternatives = '0|1|2|3|4|5' if question.is_a? Dropdown<br /> question.size = '60, 5' if question.is_a? TextArea<br /> question.size = '30' if question.is_a? TextField<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> Constants created were: <br /> <br /> &lt;pre&gt;<br /> QUESTION_MIN_SCORE = 0<br /> QUESTION_MAX_SCORE = 1<br /> QUESTION_MAX_LABEL = 'Strongly agree'<br /> QUESTION_MIN_LABEL = 'Strongly disagree'<br /> QUESTION_CRITERION_SIZE = '50, 3'<br /> DROPDOWN_SCALE = '0|1|2|3|4|5'<br /> TEXT_AREA_SIZE = '60, 5'<br /> TEXT_FIELD_SIZE = '30'<br /> &lt;/pre&gt;<br /> <br /> We refactored the above method by making the constants and using them instead of just passing literals. We have also improved the logic by using the better conditions and variables in method.<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> num_of_existed_questions = Questionnaire.find(params[:id]).questions.size<br /> question_nums =params[:question][:total_num].to_i<br /> total_question_nums = ((num_of_existed_questions + 1)..(num_of_existed_questions + question_nums))<br /> <br /> total_question_nums.each do |i|<br /> question = Object.const_get(params[:question][:type]).create(<br /> txt: '',<br /> questionnaire_id: params[:id],<br /> seq: i,<br /> type: params[:question][:type],<br /> break_before: true<br /> )<br /> if question.is_a? ScoredQuestion<br /> question.weight = MAXIMUM_QUESTION_SCORE<br /> question.min_label = QUESTION_MIN_LABEL<br /> question.max_label = QUESTION_MAX_LABEL<br /> end<br /> <br /> question.alternatives = DROPDOWN_SCALE if question.is_a? Dropdown<br /> question.size = question_size(question)<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(params[:id].to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Unnecessary Parameters =====<br /> <br /> This change was done in Quiz_questionnaire.rb file. Questionnaire_id is the variable which has value of params[:id], this variable was passed as method parameter in many calls when call quiz questionnaire controller.<br /> <br /> =====Remove Unnecessary Checks=====<br /> <br /> In few methods like save_questions checks like “@questionnaire.id if !@questionnaire.id.nil? and @questionnaire.id &gt; 0” are added. These kind of checks are unnecessary because since value of questionnaire.id will be present is @questionnaire class variable. To clear up such code we have removed unnecessary check. <br /> <br /> =====Update Questionnaire Spec=====<br /> <br /> As mentioned in US2, we have removed create_questionnaire method and we have also removed corresponding test of that method in spec file. Rest no changes were done in spec file. We had run the tests before and after refactoring and they have passed. <br /> <br /> =====Update Quiz Questionnaire Spec=====<br /> <br /> As mentioned in US3 we have removed unnecessary variables, one of the variable was questionnaire_id which was just params[:id]. This variable was passed as parameter in many of quiz questionnaire methods. we have removed this variable and method calls are changed. We have changed test cases also of all the corresponding method.<br /> <br /> ==Test Plan==<br /> <br /> Our test plan is to create or existing test cases for all the user stories we have created and run it as soon as we are completing the user story. For most of our changes we did not have to create new test cases but we have modified exiting test cases for all the functionalities that we have been modifying. We have made changes in 2 spec file and have run the test cases. <br /> <br /> Below is the screenshot of the result after running the test cases.<br /> <br /> ==LoopHoles== <br /> <br /> * In several places begin and rescue statement are used without properly understanding the functionality. Due to this critical error messages are lost and debugging those error would be difficult. To fix this proper error log is added and begin rescue is removed.<br /> * On editing any questionnaire, they are not getting updated. Values are being hardcoded at backend and questionnaire never gets updated. Issue#1550 has been created to fix this bug.<br /> <br /> ==Team==<br /> =====Mentor===== <br /> Prof. Edward Gehringer<br /> =====Members===== <br /> * Garima Garima, Ggarima<br /> * Bharat Bhardwaj, Bbhardw<br /> * Piyush Tiwari, Ptiwari<br /> <br /> ==References==<br /> <br /> #[https://expertiza.ncsu.edu/ Expertiza]<br /> #[https://github.com/expertiza/expertiza Expertiza GitHub]<br /> #[https://github.com/piyushtiw/expertiza/pull/14/files#diff-b41fa84d1ee0c03c4e301f977fbe453d Pull Request to Merge]<br /> #[http://152.7.98.234:8080/ Deployed Changes Userid - instructor6 and Password - password]<br /> #[https://github.com/piyushtiw/expertiza/projects/2 GitHub Project Board]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-_E1946._Refactor_Questionnaire_controller&diff=126992 2019-11-03T19:56:08Z

<p>Ggarima: </p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> <br /> __TOC__<br /> <br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==About Questionnaire Controller==<br /> <br /> Questionnaire is the superclass for all kinds of questionnaires and rubrics, rubrics is used for evaluating submissions and teammate contributions, and taking quizzes and surveys. All of these are subclasses of Questionnaire. This controller is used for creating, displaying, and managing Questionnaires. Different type of questionnaire can be created in Expertiza like Review, Metareview, Teammate review, Quiz Questionnaire, Global Survey, Course Survey and many more. This Controller is widely used and malfunctions can cause many issues in different parts of the system.<br /> <br /> Below is screenshot of questionnaire on expertiza. It shows all the kinds of questionnaire we can create on expertiza. <br /> <br /> [[File:Questionnaire_1.png]]<br /> <br /> Below is screenshot of all the review questionnaire we have created till now. We can edit, delete and do many other operations on questionnaire.<br /> <br /> [[File:Questionnaire_view.png]]<br /> <br /> Below is screenshot which shows how we can edit any questionnaire. <br /> <br /> [[File:Questionnaire_edit_3.png]]<br /> <br /> ==Why Refactor Questionnaire Controller==<br /> <br /> In Questionnaire controller below are some of the problems which needs refactoring: <br /> <br /> * Renaming the methods breaking Rubys naming conventions. <br /> * Refactoring the methods doing multiple tasks and breaking them in different modules.<br /> * Reducing the length of methods longer than 50 lines of code.<br /> * Removing the string literal values used in controller.<br /> * Separating the business logic from controller and putting it in method.<br /> * Remove variables behaving same as ruby's given functionality.<br /> * Commenting the code properly for easy understanding.<br /> <br /> ==Files Modified==<br /> <br /> Below are the five file we changed as part of refactoring<br /> <br /> =====Questionnaire Controller===== <br /> This is the questionnaires_controller.rb which handles all the CRUD operation performed on any kind of questionnaire - review or surveys, add weightage to all questions, selecting type of questions. This controller holds the major part of work done for creating questions. Creating of questionnaire was one method which was extremely complicated and not well commented about what is going on. Multiple things were done in just one method which we broke in modules doing that specific task. This controller was holding the business logic as well, which we can move to model. Variables were created separate to get value from UI. At many places string literals were being hardcoded, which were made as constants.<br /> =====Questionnaire Model=====<br /> This is the questionnaire.rb model file and we have added self method in it, which will create questionnaire object for us and we will get that object in controller and process it in controller. <br /> =====Questionnaire Spec=====<br /> This is the questionnaire_controller_spec.rb file and we have changed this file in order to test the changes we have made in Questionnaire controller.<br /> =====Quiz Questionnaire Controller=====<br /> This file is quiz_questionnaire_controller.rb and was calling multiple methods of quiz questionnaire by passing questionnaire id as parameter which we have removed. <br /> =====Quiz Questionnaire Spec=====<br /> This is quiz_questionnaire_spec.rb was changed as we have removed questionnaire ID from methods in Quiz Questionnaire controller.<br /> <br /> ==User Stories==<br /> <br /> We have used Github project board to keep track of work that needs to be refactored. Below were the user stories that we have created: <br /> <br /> * '''US1''' - As a developer i want to analyse create questionnaire so that i can refactor and break it into modules.<br /> * '''US2''' - As a developer i want to refactor the create_questionnaire method by giving it meaningful name and improving code so that it does not conflict with ruby naming standard.<br /> * '''US3''' - As a developer i want to remove questionnaire_id with params[:id] so that we can remove unnecessary variables.<br /> * '''US4''' - As a developer i want to remove all hardcoded values of alternatives, min label and max label and put them in literals, so that code can be aligned to coding standards.<br /> * '''US5''' - As a developer i want to analyse why Questionnaire is being checked as QuizQuestionnaire multiple times and functionality is being changed, so that we can make quiz questionnaire same as rest.<br /> * '''US6''' - As a developer i want to analyse why questionnaire_id has been passed as parameter in many question so that i can refactor the code.<br /> * '''US7''' - As a developer i want to run rspecs in Questionnaire spec to so that i can make sure the changes made are working correct.<br /> * '''US8''' - As a developer i want to run rspecs in Quiz Questionnaire spec to so that i can make sure the changes made are working correct.<br /> <br /> ==Refactoring==<br /> <br /> =====Refactor Create Method===== <br /> This method was in questionnaires_controller.rb<br /> Create method was very long in Questionnaire controller and was not self explanatory, number of characters in one line is more than 80 and cant be seen in one window.<br /> '''Before Refactoring'''<br /> &lt;pre&gt;<br /> def create<br /> if params[:questionnaire][:name].blank?<br /> flash[:error] = 'A rubric or survey must have a title.'<br /> redirect_to controller: 'questionnaires', action: 'new', model: params[:questionnaire][:type], private: params[:questionnaire][:private]<br /> else<br /> questionnaire_private = params[:questionnaire][:private] == 'true'<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> begin<br /> @questionnaire = Object.const_get(params[:questionnaire][:type]).new if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> begin<br /> @questionnaire.private = questionnaire_private<br /> @questionnaire.name = params[:questionnaire][:name]<br /> @questionnaire.instructor_id = session[:user].id<br /> @questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> @questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> @questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> # E1903 : We are not sure of other type of cases, so have added a if statement. If there are only 5 cases, remove the if statement<br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> @questionnaire.display_type = display_type<br /> @questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> @questionnaire.save<br /> # Create node<br /> tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')<br /> flash[:success] = 'You have successfully created a questionnaire!'<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> In this user story we created self method in questionnaire model which will create questionnaire object and pass it in controller. Self method was divided in to two different modules which we then called into self. <br /> <br /> Method create_questionnaire_node(questionnaire) - This method will create a Tree node for new questionnaire in Expertiza&lt;br/&gt;<br /> &lt;pre&gt;<br /> # This method is used to create Treenode for newly created questionnaire<br /> def create_questionnaire_node(questionnaire)<br /> tree_folder = TreeFolder.where(['name like ?', questionnaire.display_type]).first<br /> <br /> if tree_folder.present?<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: questionnaire.id, type: 'QuestionnaireNode')<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> Method display_type_for_questionnaire(params) - This method will tell us about display type for new questionnaire in Expertiza&lt;br/&gt;<br /> <br /> &lt;pre&gt;<br /> # Displaying the newly created questionnaire<br /> def display_type_for_questionnaire(params)<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> <br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> <br /> display_type<br /> end<br /> &lt;/pre&gt;<br /> <br /> This method below will be the main method for creating the questionnaire object and will call the two method we have written above. <br /> Self - Assigning all variable values from UI into questionnaire object + create_questionnaire_node(questionnaire) + display_type_for_questionnaire(params)<br /> <br /> &lt;pre&gt;<br /> # This method will create a questionnaire object and will be called from controller. <br /> class &lt;&lt; self<br /> def create_new_questionnaire_obj(params, session)<br /> # Assigning values passed from UI in params[:id] to questionnaire object<br /> if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> questionnaire = Object.const_get(params[:questionnaire][:type]).new <br /> questionnaire.private = params[:questionnaire][:private] == 'true'<br /> questionnaire.name = params[:questionnaire][:name]<br /> questionnaire.instructor_id = session[:user].id<br /> questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> questionnaire.display_type = display_type_for_questionnaire(params)<br /> questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> <br /> if questionnaire.save<br /> create_questionnaire_node(questionnaire)<br /> end<br /> # returning the questionnaire object to calling method create in controller<br /> questionnaire<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Refactor Create Questionnaire Method===== <br /> <br /> This method was in questionnaires_controller.rb and in this user story after deep analysis of create_questionnaire method, we found that this method has not been called anywhere so we have '''removed''' this method from the questionnaire controller. <br /> <br /> =====Remove Unnecessary Variables=====<br /> <br /> As a part of this user story we have removed unnecessary variables in questionnaires_controller.rb file. In this file methods like add_new_questions, save_all_questions, save_questions, save_new_questions, delete_questions, local variable questionnaire_id was passed as a method argument which is not actually required since this value can be fetched from class variable @questionnaire.id or from params[:id]. So, this variable was unnecessary. Below is the one of the methods named save_all_questions which was using questionnaire_id as method parameter and we refactored.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to save all questions in current questionnaire.<br /> def save_all_questions<br /> questionnaire_id = params[:id]<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif !questionnaire_id.nil?<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> &lt;pre&gt;<br /> def save_all_questions<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif params[:id].present?<br /> redirect_to edit_questionnaire_path(params[:id])<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Hardcoded String Literals=====<br /> <br /> As a part of this user story we have made changes in questionnaires_controller.rb file. Few methods have values directly hardcoded in code, which does not justify good coding standard. To clean up this code we used constant variables which also clearly mention what value is being set by this variable. Refactoring was done in method like add_new_questions.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> questionnaire_id = params[:id] unless params[:id].nil?<br /> num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size<br /> ((num_of_existed_questions + 1)..(num_of_existed_questions + params[:question][:total_num].to_i)).each do |i|<br /> question = Object.const_get(params[:question][:type]).create(txt: '', questionnaire_id: questionnaire_id, seq: i, type: params[:question][:type], break_before: true)<br /> if question.is_a? ScoredQuestion<br /> question.weight = 1<br /> question.max_label = 'Strongly agree'<br /> question.min_label = 'Strongly disagree'<br /> end<br /> question.size = '50, 3' if question.is_a? Criterion<br /> question.alternatives = '0|1|2|3|4|5' if question.is_a? Dropdown<br /> question.size = '60, 5' if question.is_a? TextArea<br /> question.size = '30' if question.is_a? TextField<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> Constants created were: <br /> <br /> &lt;pre&gt;<br /> QUESTION_MIN_SCORE = 0<br /> QUESTION_MAX_SCORE = 1<br /> QUESTION_MAX_LABEL = 'Strongly agree'<br /> QUESTION_MIN_LABEL = 'Strongly disagree'<br /> QUESTION_CRITERION_SIZE = '50, 3'<br /> DROPDOWN_SCALE = '0|1|2|3|4|5'<br /> TEXT_AREA_SIZE = '60, 5'<br /> TEXT_FIELD_SIZE = '30'<br /> &lt;/pre&gt;<br /> <br /> We refactored the above method by making the constants and using them instead of just passing literals. We have also improved the logic by using the better conditions and variables in method.<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> num_of_existed_questions = Questionnaire.find(params[:id]).questions.size<br /> question_nums =params[:question][:total_num].to_i<br /> total_question_nums = ((num_of_existed_questions + 1)..(num_of_existed_questions + question_nums))<br /> <br /> total_question_nums.each do |i|<br /> question = Object.const_get(params[:question][:type]).create(<br /> txt: '',<br /> questionnaire_id: params[:id],<br /> seq: i,<br /> type: params[:question][:type],<br /> break_before: true<br /> )<br /> if question.is_a? ScoredQuestion<br /> question.weight = MAXIMUM_QUESTION_SCORE<br /> question.min_label = QUESTION_MIN_LABEL<br /> question.max_label = QUESTION_MAX_LABEL<br /> end<br /> <br /> question.alternatives = DROPDOWN_SCALE if question.is_a? Dropdown<br /> question.size = question_size(question)<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(params[:id].to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Unnecessary Parameters =====<br /> <br /> This change was done in Quiz_questionnaire.rb file. Questionnaire_id is the variable which has value of params[:id], this variable was passed as method parameter in many calls when call quiz questionnaire controller.<br /> <br /> =====Remove Unnecessary Checks=====<br /> <br /> In few methods like save_questions checks like “@questionnaire.id if !@questionnaire.id.nil? and @questionnaire.id &gt; 0” are added. These kind of checks are unnecessary because since value of questionnaire.id will be present is @questionnaire class variable. To clear up such code we have removed unnecessary check. <br /> <br /> =====Update Questionnaire Spec=====<br /> <br /> As mentioned in US2, we have removed create_questionnaire method and we have also removed corresponding test of that method in spec file. Rest no changes were done in spec file. We had run the tests before and after refactoring and they have passed. <br /> <br /> =====Update Quiz Questionnaire Spec=====<br /> <br /> As mentioned in US3 we have removed unnecessary variables, one of the variable was questionnaire_id which was just params[:id]. This variable was passed as parameter in many of quiz questionnaire methods. we have removed this variable and method calls are changed. We have changed test cases also of all the corresponding method.<br /> <br /> ==Testing==<br /> <br /> Our task was refactoring the controller so we have mainly focused on to pass the tests which are already written. In the refactoring we have added the methods that are private so according the Messages sent to self should not be tested behaviour we have not added extra tests.<br /> <br /> ==LoopHoles== <br /> <br /> * In several places begin and rescue statement are used without properly understanding the functionality. Due to this critical error messages are lost and debugging those error would be difficult. To fix this proper error log is added and begin rescue is removed.<br /> * On editing any questionnaire, they are not getting updated. Values are being hardcoded at backend and questionnaire never gets updated. Issue#1550 has been created to fix this bug.<br /> <br /> ==Team==<br /> =====Mentor===== <br /> Prof. Edward Gehringer<br /> =====Members===== <br /> * Garima Garima, Ggarima<br /> * Bharat Bhardwaj, Bbhardw<br /> * Piyush Tiwari, Ptiwari<br /> <br /> ==References==<br /> <br /> #[https://expertiza.ncsu.edu/ Expertiza]<br /> #[https://github.com/expertiza/expertiza Expertiza GitHub]<br /> #[https://github.com/piyushtiw/expertiza/pull/14/files#diff-b41fa84d1ee0c03c4e301f977fbe453d Pull Request to Merge]<br /> #[http://152.7.98.234:8080/ Deployed Changes Userid - instructor6 and Password - password]<br /> #[https://github.com/piyushtiw/expertiza/projects/2 GitHub Project Board]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-_E1946._Refactor_Questionnaire_controller&diff=126991 2019-11-03T19:41:17Z

<p>Ggarima: </p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> <br /> __TOC__<br /> <br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==About Questionnaire Controller==<br /> <br /> Questionnaire is the superclass for all kinds of questionnaires and rubrics, rubrics is used for evaluating submissions and teammate contributions, and taking quizzes and surveys. All of these are subclasses of Questionnaire. This controller is used for creating, displaying, and managing Questionnaires. Different type of questionnaire can be created in Expertiza like Review, Metareview, Teammate review, Quiz Questionnaire, Global Survey, Course Survey and many more. This Controller is widely used and malfunctions can cause many issues in different parts of the system.<br /> <br /> Below is screenshot of questionnaire on expertiza. It shows all the kinds of questionnaire we can create on expertiza. <br /> <br /> [[File:Questionnaire_1.png]]<br /> <br /> Below is screenshot of all the review questionnaire we have created till now. We can edit, delete and do many other operations on questionnaire.<br /> <br /> [[File:Questionnaire_view.png]]<br /> <br /> Below is screenshot which shows how we can edit any questionnaire. <br /> <br /> [[File:Questionnaire_edit_3.png]]<br /> <br /> ==Why Refactor Questionnaire Controller==<br /> <br /> In Questionnaire controller below are some of the problems which needs refactoring: <br /> <br /> * Renaming the methods breaking Rubys naming conventions. <br /> * Refactoring the methods doing multiple tasks and breaking them in different modules.<br /> * Reducing the length of methods longer than 50 lines of code.<br /> * Removing the string literal values used in controller.<br /> * Separating the business logic from controller and putting it in method.<br /> * Remove variables behaving same as ruby's given functionality.<br /> * Commenting the code properly for easy understanding.<br /> <br /> ==Files Modified==<br /> <br /> Below are the five file we changed as part of refactoring<br /> <br /> =====Questionnaire Controller===== <br /> This is the questionnaires_controller.rb which handles all the CRUD operation performed on any kind of questionnaire - review or surveys, add weightage to all questions, selecting type of questions. This controller holds the major part of work done for creating questions. Creating of questionnaire was one method which was extremely complicated and not well commented about what is going on. Multiple things were done in just one method which we broke in modules doing that specific task. This controller was holding the business logic as well, which we can move to model. Variables were created separate to get value from UI. At many places string literals were being hardcoded, which were made as constants.<br /> =====Questionnaire Model=====<br /> This is the questionnaire.rb model file and we have added self method in it, which will create questionnaire object for us and we will get that object in controller and process it in controller. <br /> =====Questionnaire Spec=====<br /> This is the questionnaire_controller_spec.rb file and we have changed this file in order to test the changes we have made in Questionnaire controller.<br /> =====Quiz Questionnaire Controller=====<br /> This file is quiz_questionnaire_controller.rb and was calling multiple methods of quiz questionnaire by passing questionnaire id as parameter which we have removed. <br /> =====Quiz Questionnaire Spec=====<br /> This is quiz_questionnaire_spec.rb was changed as we have removed questionnaire ID from methods in Quiz Questionnaire controller.<br /> <br /> ==User Stories==<br /> <br /> We have used Github project board to keep track of work that needs to be refactored. Below were the user stories that we have created: <br /> <br /> * '''US1''' - As a developer i want to analyse create questionnaire so that i can refactor and break it into modules.<br /> * '''US2''' - As a developer i want to refactor the create_questionnaire method by giving it meaningful name and improving code so that it does not conflict with ruby naming standard.<br /> * '''US3''' - As a developer i want to remove questionnaire_id with params[:id] so that we can remove unnecessary variables.<br /> * '''US4''' - As a developer i want to remove all hardcoded values of alternatives, min label and max label and put them in literals, so that code can be aligned to coding standards.<br /> * '''US5''' - As a developer i want to analyse why Questionnaire is being checked as QuizQuestionnaire multiple times and functionality is being changed, so that we can make quiz questionnaire same as rest.<br /> * '''US6''' - As a developer i want to analyse why questionnaire_id has been passed as parameter <br /> * '''US6''' - As a developer i want to run rspecs in Questionnaire spec to so that i can make sure the changes made are working correct.<br /> * '''US7''' - As a developer i want to run rspecs in Quiz Questionnaire spec to so that i can make sure the changes made are working correct.<br /> <br /> ==Refactoring==<br /> <br /> =====Refactor Create Method===== <br /> This method was in questionnaires_controller.rb<br /> Create method was very long in Questionnaire controller and was not self explanatory, number of characters in one line is more than 80 and cant be seen in one window.<br /> '''Before Refactoring'''<br /> &lt;pre&gt;<br /> def create<br /> if params[:questionnaire][:name].blank?<br /> flash[:error] = 'A rubric or survey must have a title.'<br /> redirect_to controller: 'questionnaires', action: 'new', model: params[:questionnaire][:type], private: params[:questionnaire][:private]<br /> else<br /> questionnaire_private = params[:questionnaire][:private] == 'true'<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> begin<br /> @questionnaire = Object.const_get(params[:questionnaire][:type]).new if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> begin<br /> @questionnaire.private = questionnaire_private<br /> @questionnaire.name = params[:questionnaire][:name]<br /> @questionnaire.instructor_id = session[:user].id<br /> @questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> @questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> @questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> # E1903 : We are not sure of other type of cases, so have added a if statement. If there are only 5 cases, remove the if statement<br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> @questionnaire.display_type = display_type<br /> @questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> @questionnaire.save<br /> # Create node<br /> tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')<br /> flash[:success] = 'You have successfully created a questionnaire!'<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> In this user story we created self method in questionnaire model which will create questionnaire object and pass it in controller. Self method was divided in to two different modules which we then called into self. <br /> <br /> Method create_questionnaire_node(questionnaire) - This method will create a Tree node for new questionnaire in Expertiza&lt;br/&gt;<br /> &lt;pre&gt;<br /> # This method is used to create Treenode for newly created questionnaire<br /> def create_questionnaire_node(questionnaire)<br /> tree_folder = TreeFolder.where(['name like ?', questionnaire.display_type]).first<br /> <br /> if tree_folder.present?<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: questionnaire.id, type: 'QuestionnaireNode')<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> Method display_type_for_questionnaire(params) - This method will tell us about display type for new questionnaire in Expertiza&lt;br/&gt;<br /> <br /> &lt;pre&gt;<br /> # Displaying the newly created questionnaire<br /> def display_type_for_questionnaire(params)<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> <br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> <br /> display_type<br /> end<br /> &lt;/pre&gt;<br /> <br /> This method below will be the main method for creating the questionnaire object and will call the two method we have written above. <br /> Self - Assigning all variable values from UI into questionnaire object + create_questionnaire_node(questionnaire) + display_type_for_questionnaire(params)<br /> <br /> &lt;pre&gt;<br /> # This method will create a questionnaire object and will be called from controller. <br /> class &lt;&lt; self<br /> def create_new_questionnaire_obj(params, session)<br /> # Assigning values passed from UI in params[:id] to questionnaire object<br /> if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> questionnaire = Object.const_get(params[:questionnaire][:type]).new <br /> questionnaire.private = params[:questionnaire][:private] == 'true'<br /> questionnaire.name = params[:questionnaire][:name]<br /> questionnaire.instructor_id = session[:user].id<br /> questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> questionnaire.display_type = display_type_for_questionnaire(params)<br /> questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> <br /> if questionnaire.save<br /> create_questionnaire_node(questionnaire)<br /> end<br /> # returning the questionnaire object to calling method create in controller<br /> questionnaire<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Refactor Create Questionnaire Method===== <br /> <br /> This method was in questionnaires_controller.rb and in this user story after deep analysis of create_questionnaire method, we found that this method has not been called anywhere so we have '''removed''' this method from the questionnaire controller. <br /> <br /> =====Remove Unnecessary Variables=====<br /> <br /> As a part of this user story we have removed unnecessary variables in questionnaires_controller.rb file. In this file methods like add_new_questions, save_all_questions, save_questions, save_new_questions, delete_questions, local variable questionnaire_id was passed as a method argument which is not actually required since this value can be fetched from class variable @questionnaire.id or from params[:id]. So, this variable was unnecessary. Below is the one of the methods named save_all_questions which was using questionnaire_id as method parameter and we refactored.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to save all questions in current questionnaire.<br /> def save_all_questions<br /> questionnaire_id = params[:id]<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif !questionnaire_id.nil?<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> &lt;pre&gt;<br /> def save_all_questions<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif params[:id].present?<br /> redirect_to edit_questionnaire_path(params[:id])<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Hardcoded String Literals=====<br /> <br /> As a part of this user story we have made changes in questionnaires_controller.rb file. Few methods have values directly hardcoded in code, which does not justify good coding standard. To clean up this code we used constant variables which also clearly mention what value is being set by this variable. Refactoring was done in method like add_new_questions.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> questionnaire_id = params[:id] unless params[:id].nil?<br /> num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size<br /> ((num_of_existed_questions + 1)..(num_of_existed_questions + params[:question][:total_num].to_i)).each do |i|<br /> question = Object.const_get(params[:question][:type]).create(txt: '', questionnaire_id: questionnaire_id, seq: i, type: params[:question][:type], break_before: true)<br /> if question.is_a? ScoredQuestion<br /> question.weight = 1<br /> question.max_label = 'Strongly agree'<br /> question.min_label = 'Strongly disagree'<br /> end<br /> question.size = '50, 3' if question.is_a? Criterion<br /> question.alternatives = '0|1|2|3|4|5' if question.is_a? Dropdown<br /> question.size = '60, 5' if question.is_a? TextArea<br /> question.size = '30' if question.is_a? TextField<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> Constants created were: <br /> <br /> &lt;pre&gt;<br /> QUESTION_MIN_SCORE = 0<br /> QUESTION_MAX_SCORE = 1<br /> QUESTION_MAX_LABEL = 'Strongly agree'<br /> QUESTION_MIN_LABEL = 'Strongly disagree'<br /> QUESTION_CRITERION_SIZE = '50, 3'<br /> DROPDOWN_SCALE = '0|1|2|3|4|5'<br /> TEXT_AREA_SIZE = '60, 5'<br /> TEXT_FIELD_SIZE = '30'<br /> &lt;/pre&gt;<br /> <br /> We refactored the above method by making the constants and using them instead of just passing literals. We have also improved the logic by using the better conditions and variables in method.<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> num_of_existed_questions = Questionnaire.find(params[:id]).questions.size<br /> question_nums =params[:question][:total_num].to_i<br /> total_question_nums = ((num_of_existed_questions + 1)..(num_of_existed_questions + question_nums))<br /> <br /> total_question_nums.each do |i|<br /> question = Object.const_get(params[:question][:type]).create(<br /> txt: '',<br /> questionnaire_id: params[:id],<br /> seq: i,<br /> type: params[:question][:type],<br /> break_before: true<br /> )<br /> if question.is_a? ScoredQuestion<br /> question.weight = MAXIMUM_QUESTION_SCORE<br /> question.min_label = QUESTION_MIN_LABEL<br /> question.max_label = QUESTION_MAX_LABEL<br /> end<br /> <br /> question.alternatives = DROPDOWN_SCALE if question.is_a? Dropdown<br /> question.size = question_size(question)<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(params[:id].to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Unnecessary Checks=====<br /> <br /> In few methods like save_questions checks like “@questionnaire.id if !@questionnaire.id.nil? and @questionnaire.id &gt; 0” are added. These kind of checks are unnecessary because since value of questionnaire.id will be present is @questionnaire class variable. To clear up such code we have removed unnecessary check. <br /> <br /> =====Update Questionnaire Spec=====<br /> <br /> As mentioned in US2, we have removed create_questionnaire method and we have also removed corresponding test of that method in spec file. Rest no changes were done in spec file. We had run the tests before and after refactoring and they have passed. <br /> <br /> =====Update Quiz Questionnaire Spec=====<br /> <br /> As mentioned in US we have removed unnecessary variables We have removed extra arguments passed in function call which are not required. To pass the test for the above changes we have removed arguments in the method call.<br /> <br /> ==Testing==<br /> <br /> Our task was refactoring the controller so we have mainly focused on to pass the tests which are already written. In the refactoring we have added the methods that are private so according the Messages sent to self should not be tested behaviour we have not added extra tests.<br /> <br /> ==LoopHoles== <br /> <br /> In several places begin and rescue statement are used without properly understanding the functionality. Due to this critical error messages are lost and debugging those error would be difficult. To fix this proper error log is added and begin rescue is removed.<br /> <br /> ==Team==<br /> =====Mentor===== <br /> Prof. Edward Gehringer<br /> =====Members===== <br /> * Garima Garima, Ggarima<br /> * Bharat Bhardwaj, Bbhardw<br /> * Piyush Tiwari, Ptiwari<br /> <br /> ==References==<br /> <br /> #[https://expertiza.ncsu.edu/ Expertiza]<br /> #[https://github.com/expertiza/expertiza Expertiza GitHub]<br /> #[https://github.com/piyushtiw/expertiza/pull/14/files#diff-b41fa84d1ee0c03c4e301f977fbe453d Pull Request to Merge]<br /> #[http://152.7.98.234:8080/ Deployed Changes Userid - instructor6 and Password - password]<br /> #[https://github.com/piyushtiw/expertiza/projects/2 GitHub Project Board]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-_E1946._Refactor_Questionnaire_controller&diff=126987 2019-11-03T19:30:14Z

<p>Ggarima: </p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> <br /> __TOC__<br /> <br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==About Questionnaire Controller==<br /> <br /> Questionnaire is the superclass for all kinds of questionnaires and rubrics, rubrics is used for evaluating submissions and teammate contributions, and taking quizzes and surveys. All of these are subclasses of Questionnaire. This controller is used for creating, displaying, and managing Questionnaires. Different type of questionnaire can be created in Expertiza like Review, Metareview, Teammate review, Quiz Questionnaire, Global Survey, Course Survey and many more. This Controller is widely used and malfunctions can cause many issues in different parts of the system.<br /> <br /> Below is screenshot of questionnaire on expertiza. It shows all the kinds of questionnaire we can create on expertiza. <br /> <br /> [[File:Questionnaire_1.png]]<br /> <br /> Below is screenshot of all the review questionnaire we have created till now. We can edit, delete and do many other operations on questionnaire.<br /> <br /> [[File:Questionnaire_view.png]]<br /> <br /> Below is screenshot which shows how we can edit any questionnaire. <br /> <br /> [[File:Questionnaire_edit_3.png]]<br /> <br /> ==Why Refactor Questionnaire Controller==<br /> <br /> In Questionnaire controller below are some of the problems which needs refactoring: <br /> <br /> * Renaming the methods breaking Rubys naming conventions. <br /> * Refactoring the methods doing multiple tasks and breaking them in different modules.<br /> * Reducing the length of methods longer than 50 lines of code.<br /> * Removing the string literal values used in controller.<br /> * Separating the business logic from controller and putting it in method.<br /> * Remove variables behaving same as ruby's given functionality.<br /> * Commenting the code properly for easy understanding.<br /> <br /> ==Files Modified==<br /> <br /> Below are the five file we changed as part of refactoring<br /> <br /> =====Questionnaire Controller===== <br /> This is the questionnaires_controller.rb which handles all the CRUD operation performed on any kind of questionnaire - review or surveys, add weightage to all questions, selecting type of questions. This controller holds the major part of work done for creating questions. Creating of questionnaire was one method which was extremely complicated and not well commented about what is going on. Multiple things were done in just one method which we broke in modules doing that specific task. This controller was holding the business logic as well, which we can move to model. Variables were created separate to get value from UI. At many places string literals were being hardcoded, which were made as constants.<br /> =====Questionnaire Model=====<br /> This is the questionnaire.rb model file and we have added self method in it, which will create questionnaire object for us and we will get that object in controller and process it in controller. <br /> =====Questionnaire Spec=====<br /> This is the questionnaire_controller_spec.rb file and we have changed this file in order to test the changes we have made in Questionnaire controller.<br /> =====Quiz Questionnaire Controller=====<br /> This file is quiz_questionnaire_controller.rb and was calling multiple methods of quiz questionnaire by passing questionnaire id as parameter which we have removed. <br /> =====Quiz Questionnaire Spec=====<br /> This is quiz_questionnaire_spec.rb was changed as we have removed questionnaire ID from methods in Quiz Questionnaire controller.<br /> <br /> ==User Stories==<br /> <br /> We have used Github project board to keep track of work that needs to be refactored. Below were the user stories that we have created: <br /> <br /> * '''US1''' - As a developer i want to analyze create questionnaire so that i can refactor and break it into modules.<br /> * '''US2''' - As a developer i want to refactor the create_questionnaire method by giving it meaningful name and improving code so that it does not conflict with ruby naming standard.<br /> * '''US3''' - As a developer i want to remove questionnaire_id with params[:id] so that we can remove unnecessary variables.<br /> * '''US4''' - As a developer i want to remove all hardcoded values of alternatives, min label and max label and put them in literals, so that code can be aligned to coding standards.<br /> * '''US5''' - As a developer i want to analyse why Questionnaire is being checked as QuizQuestionnaire multiple times and functionality is being changed, so that we can make quiz questionnaire same as rest.<br /> * '''US6''' - As a developer i want to run rspecs in Questionnaire spec to so that i can make sure the changes made are working correct.<br /> * '''US7''' - As a developer i want to run rspecs in Quiz Questionnaire spec to so that i can make sure the changes made are working correct.<br /> <br /> ==Refactoring==<br /> <br /> =====Refactor Create Method===== <br /> This method was in questionnaires_controller.rb<br /> Create method was very long in Questionnaire controller and was not self explanatory, number of characters in one line is more than 80 and cant be seen in one window.<br /> '''Before Refactoring'''<br /> &lt;pre&gt;<br /> def create<br /> if params[:questionnaire][:name].blank?<br /> flash[:error] = 'A rubric or survey must have a title.'<br /> redirect_to controller: 'questionnaires', action: 'new', model: params[:questionnaire][:type], private: params[:questionnaire][:private]<br /> else<br /> questionnaire_private = params[:questionnaire][:private] == 'true'<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> begin<br /> @questionnaire = Object.const_get(params[:questionnaire][:type]).new if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> begin<br /> @questionnaire.private = questionnaire_private<br /> @questionnaire.name = params[:questionnaire][:name]<br /> @questionnaire.instructor_id = session[:user].id<br /> @questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> @questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> @questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> # E1903 : We are not sure of other type of cases, so have added a if statement. If there are only 5 cases, remove the if statement<br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> @questionnaire.display_type = display_type<br /> @questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> @questionnaire.save<br /> # Create node<br /> tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')<br /> flash[:success] = 'You have successfully created a questionnaire!'<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> In this user story we created self method in questionnaire model which will create questionnaire object and pass it in controller. Self method was divided in to two different modules which we then called into self. <br /> <br /> Method create_questionnaire_node(questionnaire) - This method will create a Tree node for new questionnaire in Expertiza&lt;br/&gt;<br /> &lt;pre&gt;<br /> # This method is used to create Treenode for newly created questionnaire<br /> def create_questionnaire_node(questionnaire)<br /> tree_folder = TreeFolder.where(['name like ?', questionnaire.display_type]).first<br /> <br /> if tree_folder.present?<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: questionnaire.id, type: 'QuestionnaireNode')<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> Method display_type_for_questionnaire(params) - This method will tell us about display type for new questionnaire in Expertiza&lt;br/&gt;<br /> <br /> &lt;pre&gt;<br /> # Displaying the newly created questionnaire<br /> def display_type_for_questionnaire(params)<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> <br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> <br /> display_type<br /> end<br /> &lt;/pre&gt;<br /> <br /> This method below will be the main method for creating the questionnaire object and will call the two method we have written above. <br /> Self - Assigning all variable values from UI into questionnaire object + create_questionnaire_node(questionnaire) + display_type_for_questionnaire(params)<br /> <br /> &lt;pre&gt;<br /> # This method will create a questionnaire object and will be called from controller. <br /> class &lt;&lt; self<br /> def create_new_questionnaire_obj(params, session)<br /> # Assigning values passed from UI in params[:id] to questionnaire object<br /> if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> questionnaire = Object.const_get(params[:questionnaire][:type]).new <br /> questionnaire.private = params[:questionnaire][:private] == 'true'<br /> questionnaire.name = params[:questionnaire][:name]<br /> questionnaire.instructor_id = session[:user].id<br /> questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> questionnaire.display_type = display_type_for_questionnaire(params)<br /> questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> <br /> if questionnaire.save<br /> create_questionnaire_node(questionnaire)<br /> end<br /> # returning the questionnaire object to calling method create in controller<br /> questionnaire<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Refactor Create Questionnaire Method===== <br /> <br /> This method was in questionnaires_controller.rb and in this user story after deep analysis of create_questionnaire method, we found that this method has not been called anywhere so we have '''removed''' this method from the questionnaire controller. <br /> <br /> =====Remove Unnecessary Variables=====<br /> <br /> As a part of this user story we have removed unnecessary variables in questionnaires_controller.rb file. In this file methods like add_new_questions, save_all_questions, save_questions, save_new_questions, delete_questions, local variable questionnaire_id was passed as a method argument which is not actually required since this value can be fetched from class variable @questionnaire.id or from params[:id]. So, this variable was unnecessary. Below is the one of the methods named save_all_questions which was using questionnaire_id as method parameter and we refactored.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to save all questions in current questionnaire.<br /> def save_all_questions<br /> questionnaire_id = params[:id]<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif !questionnaire_id.nil?<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> &lt;pre&gt;<br /> def save_all_questions<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif params[:id].present?<br /> redirect_to edit_questionnaire_path(params[:id])<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Hardcoded String Literals=====<br /> <br /> As a part of this user story we have made changes in questionnaires_controller.rb file. Few methods have values directly hardcoded in code, which does not justify good coding standard. To clean up this code we used constant variables which also clearly mention what value is being set by this variable. Refactoring was done in method like add_new_questions.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> questionnaire_id = params[:id] unless params[:id].nil?<br /> num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size<br /> ((num_of_existed_questions + 1)..(num_of_existed_questions + params[:question][:total_num].to_i)).each do |i|<br /> question = Object.const_get(params[:question][:type]).create(txt: '', questionnaire_id: questionnaire_id, seq: i, type: params[:question][:type], break_before: true)<br /> if question.is_a? ScoredQuestion<br /> question.weight = 1<br /> question.max_label = 'Strongly agree'<br /> question.min_label = 'Strongly disagree'<br /> end<br /> question.size = '50, 3' if question.is_a? Criterion<br /> question.alternatives = '0|1|2|3|4|5' if question.is_a? Dropdown<br /> question.size = '60, 5' if question.is_a? TextArea<br /> question.size = '30' if question.is_a? TextField<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> Constants created were: <br /> <br /> &lt;pre&gt;<br /> QUESTION_MIN_SCORE = 0<br /> QUESTION_MAX_SCORE = 1<br /> QUESTION_MAX_LABEL = 'Strongly agree'<br /> QUESTION_MIN_LABEL = 'Strongly disagree'<br /> QUESTION_CRITERION_SIZE = '50, 3'<br /> DROPDOWN_SCALE = '0|1|2|3|4|5'<br /> TEXT_AREA_SIZE = '60, 5'<br /> TEXT_FIELD_SIZE = '30'<br /> &lt;/pre&gt;<br /> <br /> We refactored the above method by making the constants and using them instead of just passing literals. We have also improved the logic by using the better conditions and variables in method.<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> num_of_existed_questions = Questionnaire.find(params[:id]).questions.size<br /> question_nums =params[:question][:total_num].to_i<br /> total_question_nums = ((num_of_existed_questions + 1)..(num_of_existed_questions + question_nums))<br /> <br /> total_question_nums.each do |i|<br /> question = Object.const_get(params[:question][:type]).create(<br /> txt: '',<br /> questionnaire_id: params[:id],<br /> seq: i,<br /> type: params[:question][:type],<br /> break_before: true<br /> )<br /> if question.is_a? ScoredQuestion<br /> question.weight = MAXIMUM_QUESTION_SCORE<br /> question.min_label = QUESTION_MIN_LABEL<br /> question.max_label = QUESTION_MAX_LABEL<br /> end<br /> <br /> question.alternatives = DROPDOWN_SCALE if question.is_a? Dropdown<br /> question.size = question_size(question)<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(params[:id].to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Unnecessary Checks=====<br /> <br /> In few methods like save_questions checks like “@questionnaire.id if !@questionnaire.id.nil? and @questionnaire.id &gt; 0” are added. These kind of checks are unnecessary because since value of questionnaire.id will be present is @questionnaire class variable. To clear up such code we have removed unnecessary check. <br /> <br /> =====Update Questionnaire Spec=====<br /> <br /> There is an extra method in Questionnaire controller which is not being used any where in the application so we have removed that method. We need to delete the test for the same and this has been done in this file only.<br /> <br /> =====Update Quiz Questionnaire Spec=====<br /> <br /> We have removed extra arguments passed in function call which are not required. To pass the test for the above changes we have removed arguments in the method call.<br /> <br /> ==Testing==<br /> <br /> Our task was refactoring the controller so we have mainly focused on to pass the tests which are already written. In the refactoring we have added the methods that are private so according the Messages sent to self should not be tested behaviour we have not added extra tests.<br /> <br /> ==LoopHoles== <br /> <br /> In several places begin and rescue statement are used without properly understanding the functionality. Due to this critical error messages are lost and debugging those error would be difficult. To fix this proper error log is added and begin rescue is removed.<br /> <br /> ==Team==<br /> =====Mentor===== <br /> Prof. Edward Gehringer<br /> =====Members===== <br /> * Garima Garima, Ggarima<br /> * Bharat Bhardwaj, Bbhardw<br /> * Piyush Tiwari, Ptiwari<br /> <br /> ==References==<br /> <br /> #[https://expertiza.ncsu.edu/ Expertiza]<br /> #[https://github.com/expertiza/expertiza Expertiza GitHub]<br /> #[https://github.com/piyushtiw/expertiza/pull/14/files#diff-b41fa84d1ee0c03c4e301f977fbe453d Pull Request to Merge]<br /> #[http://152.7.98.234:8080/ Deployed Changes Userid - instructor6 and Password - password]<br /> #[https://github.com/piyushtiw/expertiza/projects/2 GitHub Project Board]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=File:Questionnaire_view.png&diff=126986 2019-11-03T19:30:01Z

<p>Ggarima: </p> <hr /> <div></div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-_E1946._Refactor_Questionnaire_controller&diff=126984 2019-11-03T19:28:32Z

<p>Ggarima: </p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> <br /> __TOC__<br /> <br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==About Questionnaire Controller==<br /> <br /> Questionnaire is the superclass for all kinds of questionnaires and rubrics, rubrics is used for evaluating submissions and teammate contributions, and taking quizzes and surveys. All of these are subclasses of Questionnaire. This controller is used for creating, displaying, and managing Questionnaires. Different type of questionnaire can be created in Expertiza like Review, Metareview, Teammate review, Quiz Questionnaire, Global Survey, Course Survey and many more. This Controller is widely used and malfunctions can cause many issues in different parts of the system.<br /> <br /> Below is screenshot of questionnaire on expertiza. It shows all the kinds of questionnaire we can create on expertiza. <br /> <br /> [[File:Questionnaire_1.png]]<br /> <br /> Below is screenshot of all the review questionnaire we have created till now. We can edit, delete and do many other operations on questionnaire.<br /> <br /> [[File:Questionnaire_2.png]]<br /> <br /> Below is screenshot which shows how we can edit any questionnaire. <br /> <br /> [[File:Questionnaire_edit_3.png]]<br /> <br /> ==Why Refactor Questionnaire Controller==<br /> <br /> In Questionnaire controller below are some of the problems which needs refactoring: <br /> <br /> * Renaming the methods breaking Rubys naming conventions. <br /> * Refactoring the methods doing multiple tasks and breaking them in different modules.<br /> * Reducing the length of methods longer than 50 lines of code.<br /> * Removing the string literal values used in controller.<br /> * Separating the business logic from controller and putting it in method.<br /> * Remove variables behaving same as ruby's given functionality.<br /> * Commenting the code properly for easy understanding.<br /> <br /> ==Files Modified==<br /> <br /> Below are the five file we changed as part of refactoring<br /> <br /> =====Questionnaire Controller===== <br /> This is the questionnaires_controller.rb which handles all the CRUD operation performed on any kind of questionnaire - review or surveys, add weightage to all questions, selecting type of questions. This controller holds the major part of work done for creating questions. Creating of questionnaire was one method which was extremely complicated and not well commented about what is going on. Multiple things were done in just one method which we broke in modules doing that specific task. This controller was holding the business logic as well, which we can move to model. Variables were created separate to get value from UI. At many places string literals were being hardcoded, which were made as constants.<br /> =====Questionnaire Model=====<br /> This is the questionnaire.rb model file and we have added self method in it, which will create questionnaire object for us and we will get that object in controller and process it in controller. <br /> =====Questionnaire Spec=====<br /> This is the questionnaire_controller_spec.rb file and we have changed this file in order to test the changes we have made in Questionnaire controller.<br /> =====Quiz Questionnaire Controller=====<br /> This file is quiz_questionnaire_controller.rb and was calling multiple methods of quiz questionnaire by passing questionnaire id as parameter which we have removed. <br /> =====Quiz Questionnaire Spec=====<br /> This is quiz_questionnaire_spec.rb was changed as we have removed questionnaire ID from methods in Quiz Questionnaire controller.<br /> <br /> ==User Stories==<br /> <br /> We have used Github project board to keep track of work that needs to be refactored. Below were the user stories that we have created: <br /> <br /> * '''US1''' - As a developer i want to analyze create questionnaire so that i can refactor and break it into modules.<br /> * '''US2''' - As a developer i want to refactor the create_questionnaire method by giving it meaningful name and improving code so that it does not conflict with ruby naming standard.<br /> * '''US3''' - As a developer i want to remove questionnaire_id with params[:id] so that we can remove unnecessary variables.<br /> * '''US4''' - As a developer i want to remove all hardcoded values of alternatives, min label and max label and put them in literals, so that code can be aligned to coding standards.<br /> * '''US5''' - As a developer i want to analyse why Questionnaire is being checked as QuizQuestionnaire multiple times and functionality is being changed, so that we can make quiz questionnaire same as rest.<br /> * '''US6''' - As a developer i want to run rspecs in Questionnaire spec to so that i can make sure the changes made are working correct.<br /> * '''US7''' - As a developer i want to run rspecs in Quiz Questionnaire spec to so that i can make sure the changes made are working correct.<br /> <br /> ==Refactoring==<br /> <br /> =====Refactor Create Method===== <br /> This method was in questionnaires_controller.rb<br /> Create method was very long in Questionnaire controller and was not self explanatory, number of characters in one line is more than 80 and cant be seen in one window.<br /> '''Before Refactoring'''<br /> &lt;pre&gt;<br /> def create<br /> if params[:questionnaire][:name].blank?<br /> flash[:error] = 'A rubric or survey must have a title.'<br /> redirect_to controller: 'questionnaires', action: 'new', model: params[:questionnaire][:type], private: params[:questionnaire][:private]<br /> else<br /> questionnaire_private = params[:questionnaire][:private] == 'true'<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> begin<br /> @questionnaire = Object.const_get(params[:questionnaire][:type]).new if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> begin<br /> @questionnaire.private = questionnaire_private<br /> @questionnaire.name = params[:questionnaire][:name]<br /> @questionnaire.instructor_id = session[:user].id<br /> @questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> @questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> @questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> # E1903 : We are not sure of other type of cases, so have added a if statement. If there are only 5 cases, remove the if statement<br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> @questionnaire.display_type = display_type<br /> @questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> @questionnaire.save<br /> # Create node<br /> tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')<br /> flash[:success] = 'You have successfully created a questionnaire!'<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> In this user story we created self method in questionnaire model which will create questionnaire object and pass it in controller. Self method was divided in to two different modules which we then called into self. <br /> <br /> Method create_questionnaire_node(questionnaire) - This method will create a Tree node for new questionnaire in Expertiza&lt;br/&gt;<br /> &lt;pre&gt;<br /> # This method is used to create Treenode for newly created questionnaire<br /> def create_questionnaire_node(questionnaire)<br /> tree_folder = TreeFolder.where(['name like ?', questionnaire.display_type]).first<br /> <br /> if tree_folder.present?<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: questionnaire.id, type: 'QuestionnaireNode')<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> Method display_type_for_questionnaire(params) - This method will tell us about display type for new questionnaire in Expertiza&lt;br/&gt;<br /> <br /> &lt;pre&gt;<br /> # Displaying the newly created questionnaire<br /> def display_type_for_questionnaire(params)<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> <br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> <br /> display_type<br /> end<br /> &lt;/pre&gt;<br /> <br /> This method below will be the main method for creating the questionnaire object and will call the two method we have written above. <br /> Self - Assigning all variable values from UI into questionnaire object + create_questionnaire_node(questionnaire) + display_type_for_questionnaire(params)<br /> <br /> &lt;pre&gt;<br /> # This method will create a questionnaire object and will be called from controller. <br /> class &lt;&lt; self<br /> def create_new_questionnaire_obj(params, session)<br /> # Assigning values passed from UI in params[:id] to questionnaire object<br /> if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> questionnaire = Object.const_get(params[:questionnaire][:type]).new <br /> questionnaire.private = params[:questionnaire][:private] == 'true'<br /> questionnaire.name = params[:questionnaire][:name]<br /> questionnaire.instructor_id = session[:user].id<br /> questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> questionnaire.display_type = display_type_for_questionnaire(params)<br /> questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> <br /> if questionnaire.save<br /> create_questionnaire_node(questionnaire)<br /> end<br /> # returning the questionnaire object to calling method create in controller<br /> questionnaire<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Refactor Create Questionnaire Method===== <br /> <br /> This method was in questionnaires_controller.rb and in this user story after deep analysis of create_questionnaire method, we found that this method has not been called anywhere so we have '''removed''' this method from the questionnaire controller. <br /> <br /> =====Remove Unnecessary Variables=====<br /> <br /> As a part of this user story we have removed unnecessary variables in questionnaires_controller.rb file. In this file methods like add_new_questions, save_all_questions, save_questions, save_new_questions, delete_questions, local variable questionnaire_id was passed as a method argument which is not actually required since this value can be fetched from class variable @questionnaire.id or from params[:id]. So, this variable was unnecessary. Below is the one of the methods named save_all_questions which was using questionnaire_id as method parameter and we refactored.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to save all questions in current questionnaire.<br /> def save_all_questions<br /> questionnaire_id = params[:id]<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif !questionnaire_id.nil?<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> &lt;pre&gt;<br /> def save_all_questions<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif params[:id].present?<br /> redirect_to edit_questionnaire_path(params[:id])<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Hardcoded String Literals=====<br /> <br /> As a part of this user story we have made changes in questionnaires_controller.rb file. Few methods have values directly hardcoded in code, which does not justify good coding standard. To clean up this code we used constant variables which also clearly mention what value is being set by this variable. Refactoring was done in method like add_new_questions.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> questionnaire_id = params[:id] unless params[:id].nil?<br /> num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size<br /> ((num_of_existed_questions + 1)..(num_of_existed_questions + params[:question][:total_num].to_i)).each do |i|<br /> question = Object.const_get(params[:question][:type]).create(txt: '', questionnaire_id: questionnaire_id, seq: i, type: params[:question][:type], break_before: true)<br /> if question.is_a? ScoredQuestion<br /> question.weight = 1<br /> question.max_label = 'Strongly agree'<br /> question.min_label = 'Strongly disagree'<br /> end<br /> question.size = '50, 3' if question.is_a? Criterion<br /> question.alternatives = '0|1|2|3|4|5' if question.is_a? Dropdown<br /> question.size = '60, 5' if question.is_a? TextArea<br /> question.size = '30' if question.is_a? TextField<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> Constants created were: <br /> <br /> &lt;pre&gt;<br /> QUESTION_MIN_SCORE = 0<br /> QUESTION_MAX_SCORE = 1<br /> QUESTION_MAX_LABEL = 'Strongly agree'<br /> QUESTION_MIN_LABEL = 'Strongly disagree'<br /> QUESTION_CRITERION_SIZE = '50, 3'<br /> DROPDOWN_SCALE = '0|1|2|3|4|5'<br /> TEXT_AREA_SIZE = '60, 5'<br /> TEXT_FIELD_SIZE = '30'<br /> &lt;/pre&gt;<br /> <br /> We refactored the above method by making the constants and using them instead of just passing literals. We have also improved the logic by using the better conditions and variables in method.<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> num_of_existed_questions = Questionnaire.find(params[:id]).questions.size<br /> question_nums =params[:question][:total_num].to_i<br /> total_question_nums = ((num_of_existed_questions + 1)..(num_of_existed_questions + question_nums))<br /> <br /> total_question_nums.each do |i|<br /> question = Object.const_get(params[:question][:type]).create(<br /> txt: '',<br /> questionnaire_id: params[:id],<br /> seq: i,<br /> type: params[:question][:type],<br /> break_before: true<br /> )<br /> if question.is_a? ScoredQuestion<br /> question.weight = MAXIMUM_QUESTION_SCORE<br /> question.min_label = QUESTION_MIN_LABEL<br /> question.max_label = QUESTION_MAX_LABEL<br /> end<br /> <br /> question.alternatives = DROPDOWN_SCALE if question.is_a? Dropdown<br /> question.size = question_size(question)<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(params[:id].to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Unnecessary Checks=====<br /> <br /> In few methods like save_questions checks like “@questionnaire.id if !@questionnaire.id.nil? and @questionnaire.id &gt; 0” are added. These kind of checks are unnecessary because since value of questionnaire.id will be present is @questionnaire class variable. To clear up such code we have removed unnecessary check. <br /> <br /> =====Update Questionnaire Spec=====<br /> <br /> There is an extra method in Questionnaire controller which is not being used any where in the application so we have removed that method. We need to delete the test for the same and this has been done in this file only.<br /> <br /> =====Update Quiz Questionnaire Spec=====<br /> <br /> We have removed extra arguments passed in function call which are not required. To pass the test for the above changes we have removed arguments in the method call.<br /> <br /> ==Testing==<br /> <br /> Our task was refactoring the controller so we have mainly focused on to pass the tests which are already written. In the refactoring we have added the methods that are private so according the Messages sent to self should not be tested behaviour we have not added extra tests.<br /> <br /> ==LoopHoles== <br /> <br /> In several places begin and rescue statement are used without properly understanding the functionality. Due to this critical error messages are lost and debugging those error would be difficult. To fix this proper error log is added and begin rescue is removed.<br /> <br /> ==Team==<br /> =====Mentor===== <br /> Prof. Edward Gehringer<br /> =====Members===== <br /> * Garima Garima, Ggarima<br /> * Bharat Bhardwaj, Bbhardw<br /> * Piyush Tiwari, Ptiwari<br /> <br /> ==References==<br /> <br /> #[https://expertiza.ncsu.edu/ Expertiza]<br /> #[https://github.com/expertiza/expertiza Expertiza GitHub]<br /> #[https://github.com/piyushtiw/expertiza/pull/14/files#diff-b41fa84d1ee0c03c4e301f977fbe453d Pull Request to Merge]<br /> #[http://152.7.98.234:8080/ Deployed Changes Userid - instructor6 and Password - password]<br /> #[https://github.com/piyushtiw/expertiza/projects/2 GitHub Project Board]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=File:Questionnaire_edit_3.png&diff=126983 2019-11-03T19:28:11Z

<p>Ggarima: </p> <hr /> <div></div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=File:Questionnaire_edit_2.png&diff=126979 2019-11-03T19:24:50Z

<p>Ggarima: </p> <hr /> <div></div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-_E1946._Refactor_Questionnaire_controller&diff=126974 2019-11-03T19:22:31Z

<p>Ggarima: </p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> <br /> __TOC__<br /> <br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==About Questionnaire Controller==<br /> <br /> Questionnaire is the superclass for all kinds of questionnaires and rubrics, rubrics is used for evaluating submissions and teammate contributions, and taking quizzes and surveys. All of these are subclasses of Questionnaire. This controller is used for creating, displaying, and managing Questionnaires. Different type of questionnaire can be created in Expertiza like Review, Metareview, Teammate review, Quiz Questionnaire, Global Survey, Course Survey and many more. This Controller is widely used and malfunctions can cause many issues in different parts of the system.<br /> <br /> Below is screenshot of questionnaire on expertiza. It shows all the kinds of questionnaire we can create on expertiza. <br /> <br /> [[File:Questionnaire_1.png]]<br /> <br /> Below is screenshot of all the review questionnaire we have created till now. We can edit, delete and do many other operations on questionnaire.<br /> <br /> [[File:Questionnaire_2.png]]<br /> <br /> Below is screenshot which shows how we can edit any questionnaire. <br /> <br /> [[File:Questionnaire_edit.png]]<br /> <br /> ==Why Refactor Questionnaire Controller==<br /> <br /> In Questionnaire controller below are some of the problems which needs refactoring: <br /> <br /> * Renaming the methods breaking Rubys naming conventions. <br /> * Refactoring the methods doing multiple tasks and breaking them in different modules.<br /> * Reducing the length of methods longer than 50 lines of code.<br /> * Removing the string literal values used in controller.<br /> * Separating the business logic from controller and putting it in method.<br /> * Remove variables behaving same as ruby's given functionality.<br /> * Commenting the code properly for easy understanding.<br /> <br /> ==Files Modified==<br /> <br /> Below are the five file we changed as part of refactoring<br /> <br /> =====Questionnaire Controller===== <br /> This is the questionnaires_controller.rb which handles all the CRUD operation performed on any kind of questionnaire - review or surveys, add weightage to all questions, selecting type of questions. This controller holds the major part of work done for creating questions. Creating of questionnaire was one method which was extremely complicated and not well commented about what is going on. Multiple things were done in just one method which we broke in modules doing that specific task. This controller was holding the business logic as well, which we can move to model. Variables were created separate to get value from UI. At many places string literals were being hardcoded, which were made as constants.<br /> =====Questionnaire Model=====<br /> This is the questionnaire.rb model file and we have added self method in it, which will create questionnaire object for us and we will get that object in controller and process it in controller. <br /> =====Questionnaire Spec=====<br /> This is the questionnaire_controller_spec.rb file and we have changed this file in order to test the changes we have made in Questionnaire controller.<br /> =====Quiz Questionnaire Controller=====<br /> This file is quiz_questionnaire_controller.rb and was calling multiple methods of quiz questionnaire by passing questionnaire id as parameter which we have removed. <br /> =====Quiz Questionnaire Spec=====<br /> This is quiz_questionnaire_spec.rb was changed as we have removed questionnaire ID from methods in Quiz Questionnaire controller.<br /> <br /> ==User Stories==<br /> <br /> We have used Github project board to keep track of work that needs to be refactored. Below were the user stories that we have created: <br /> <br /> * '''US1''' - As a developer i want to analyze create questionnaire so that i can refactor and break it into modules.<br /> * '''US2''' - As a developer i want to refactor the create_questionnaire method by giving it meaningful name and improving code so that it does not conflict with ruby naming standard.<br /> * '''US3''' - As a developer i want to remove questionnaire_id with params[:id] so that we can remove unnecessary variables.<br /> * '''US4''' - As a developer i want to remove all hardcoded values of alternatives, min label and max label and put them in literals, so that code can be aligned to coding standards.<br /> * '''US5''' - As a developer i want to analyse why Questionnaire is being checked as QuizQuestionnaire multiple times and functionality is being changed, so that we can make quiz questionnaire same as rest.<br /> * '''US6''' - As a developer i want to run rspecs in Questionnaire spec to so that i can make sure the changes made are working correct.<br /> * '''US7''' - As a developer i want to run rspecs in Quiz Questionnaire spec to so that i can make sure the changes made are working correct.<br /> <br /> ==Refactoring==<br /> <br /> =====Refactor Create Method===== <br /> This method was in questionnaires_controller.rb<br /> Create method was very long in Questionnaire controller and was not self explanatory, number of characters in one line is more than 80 and cant be seen in one window.<br /> '''Before Refactoring'''<br /> &lt;pre&gt;<br /> def create<br /> if params[:questionnaire][:name].blank?<br /> flash[:error] = 'A rubric or survey must have a title.'<br /> redirect_to controller: 'questionnaires', action: 'new', model: params[:questionnaire][:type], private: params[:questionnaire][:private]<br /> else<br /> questionnaire_private = params[:questionnaire][:private] == 'true'<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> begin<br /> @questionnaire = Object.const_get(params[:questionnaire][:type]).new if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> begin<br /> @questionnaire.private = questionnaire_private<br /> @questionnaire.name = params[:questionnaire][:name]<br /> @questionnaire.instructor_id = session[:user].id<br /> @questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> @questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> @questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> # E1903 : We are not sure of other type of cases, so have added a if statement. If there are only 5 cases, remove the if statement<br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> @questionnaire.display_type = display_type<br /> @questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> @questionnaire.save<br /> # Create node<br /> tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')<br /> flash[:success] = 'You have successfully created a questionnaire!'<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> In this user story we created self method in questionnaire model which will create questionnaire object and pass it in controller. Self method was divided in to two different modules which we then called into self. <br /> <br /> Method create_questionnaire_node(questionnaire) - This method will create a Tree node for new questionnaire in Expertiza&lt;br/&gt;<br /> &lt;pre&gt;<br /> # This method is used to create Treenode for newly created questionnaire<br /> def create_questionnaire_node(questionnaire)<br /> tree_folder = TreeFolder.where(['name like ?', questionnaire.display_type]).first<br /> <br /> if tree_folder.present?<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: questionnaire.id, type: 'QuestionnaireNode')<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> Method display_type_for_questionnaire(params) - This method will tell us about display type for new questionnaire in Expertiza&lt;br/&gt;<br /> <br /> &lt;pre&gt;<br /> # Displaying the newly created questionnaire<br /> def display_type_for_questionnaire(params)<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> <br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> <br /> display_type<br /> end<br /> &lt;/pre&gt;<br /> <br /> This method below will be the main method for creating the questionnaire object and will call the two method we have written above. <br /> Self - Assigning all variable values from UI into questionnaire object + create_questionnaire_node(questionnaire) + display_type_for_questionnaire(params)<br /> <br /> &lt;pre&gt;<br /> # This method will create a questionnaire object and will be called from controller. <br /> class &lt;&lt; self<br /> def create_new_questionnaire_obj(params, session)<br /> # Assigning values passed from UI in params[:id] to questionnaire object<br /> if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> questionnaire = Object.const_get(params[:questionnaire][:type]).new <br /> questionnaire.private = params[:questionnaire][:private] == 'true'<br /> questionnaire.name = params[:questionnaire][:name]<br /> questionnaire.instructor_id = session[:user].id<br /> questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> questionnaire.display_type = display_type_for_questionnaire(params)<br /> questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> <br /> if questionnaire.save<br /> create_questionnaire_node(questionnaire)<br /> end<br /> # returning the questionnaire object to calling method create in controller<br /> questionnaire<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Refactor Create Questionnaire Method===== <br /> <br /> This method was in questionnaires_controller.rb and in this user story after deep analysis of create_questionnaire method, we found that this method has not been called anywhere so we have '''removed''' this method from the questionnaire controller. <br /> <br /> =====Remove Unnecessary Variables=====<br /> <br /> As a part of this user story we have removed unnecessary variables in questionnaires_controller.rb file. In this file methods like add_new_questions, save_all_questions, save_questions, save_new_questions, delete_questions, local variable questionnaire_id was passed as a method argument which is not actually required since this value can be fetched from class variable @questionnaire.id or from params[:id]. So, this variable was unnecessary. Below is the one of the methods named save_all_questions which was using questionnaire_id as method parameter and we refactored.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to save all questions in current questionnaire.<br /> def save_all_questions<br /> questionnaire_id = params[:id]<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif !questionnaire_id.nil?<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> &lt;pre&gt;<br /> def save_all_questions<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif params[:id].present?<br /> redirect_to edit_questionnaire_path(params[:id])<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Hardcoded String Literals=====<br /> <br /> As a part of this user story we have made changes in questionnaires_controller.rb file. Few methods have values directly hardcoded in code, which does not justify good coding standard. To clean up this code we used constant variables which also clearly mention what value is being set by this variable. Refactoring was done in method like add_new_questions.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> questionnaire_id = params[:id] unless params[:id].nil?<br /> num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size<br /> ((num_of_existed_questions + 1)..(num_of_existed_questions + params[:question][:total_num].to_i)).each do |i|<br /> question = Object.const_get(params[:question][:type]).create(txt: '', questionnaire_id: questionnaire_id, seq: i, type: params[:question][:type], break_before: true)<br /> if question.is_a? ScoredQuestion<br /> question.weight = 1<br /> question.max_label = 'Strongly agree'<br /> question.min_label = 'Strongly disagree'<br /> end<br /> question.size = '50, 3' if question.is_a? Criterion<br /> question.alternatives = '0|1|2|3|4|5' if question.is_a? Dropdown<br /> question.size = '60, 5' if question.is_a? TextArea<br /> question.size = '30' if question.is_a? TextField<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> Constants created were: <br /> <br /> &lt;pre&gt;<br /> QUESTION_MIN_SCORE = 0<br /> QUESTION_MAX_SCORE = 1<br /> QUESTION_MAX_LABEL = 'Strongly agree'<br /> QUESTION_MIN_LABEL = 'Strongly disagree'<br /> QUESTION_CRITERION_SIZE = '50, 3'<br /> DROPDOWN_SCALE = '0|1|2|3|4|5'<br /> TEXT_AREA_SIZE = '60, 5'<br /> TEXT_FIELD_SIZE = '30'<br /> &lt;/pre&gt;<br /> <br /> We refactored the above method by making the constants and using them instead of just passing literals. We have also improved the logic by using the better conditions and variables in method.<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> num_of_existed_questions = Questionnaire.find(params[:id]).questions.size<br /> question_nums =params[:question][:total_num].to_i<br /> total_question_nums = ((num_of_existed_questions + 1)..(num_of_existed_questions + question_nums))<br /> <br /> total_question_nums.each do |i|<br /> question = Object.const_get(params[:question][:type]).create(<br /> txt: '',<br /> questionnaire_id: params[:id],<br /> seq: i,<br /> type: params[:question][:type],<br /> break_before: true<br /> )<br /> if question.is_a? ScoredQuestion<br /> question.weight = MAXIMUM_QUESTION_SCORE<br /> question.min_label = QUESTION_MIN_LABEL<br /> question.max_label = QUESTION_MAX_LABEL<br /> end<br /> <br /> question.alternatives = DROPDOWN_SCALE if question.is_a? Dropdown<br /> question.size = question_size(question)<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(params[:id].to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Unnecessary Checks=====<br /> <br /> In few methods like save_questions checks like “@questionnaire.id if !@questionnaire.id.nil? and @questionnaire.id &gt; 0” are added. These kind of checks are unnecessary because since value of questionnaire.id will be present is @questionnaire class variable. To clear up such code we have removed unnecessary check. <br /> <br /> =====Update Questionnaire Spec=====<br /> <br /> There is an extra method in Questionnaire controller which is not being used any where in the application so we have removed that method. We need to delete the test for the same and this has been done in this file only.<br /> <br /> =====Update Quiz Questionnaire Spec=====<br /> <br /> We have removed extra arguments passed in function call which are not required. To pass the test for the above changes we have removed arguments in the method call.<br /> <br /> ==Testing==<br /> <br /> Our task was refactoring the controller so we have mainly focused on to pass the tests which are already written. In the refactoring we have added the methods that are private so according the Messages sent to self should not be tested behaviour we have not added extra tests.<br /> <br /> ==LoopHoles== <br /> <br /> In several places begin and rescue statement are used without properly understanding the functionality. Due to this critical error messages are lost and debugging those error would be difficult. To fix this proper error log is added and begin rescue is removed.<br /> <br /> ==Team==<br /> =====Mentor===== <br /> Prof. Edward Gehringer<br /> =====Members===== <br /> * Garima Garima, Ggarima<br /> * Bharat Bhardwaj, Bbhardw<br /> * Piyush Tiwari, Ptiwari<br /> <br /> ==References==<br /> <br /> #[https://expertiza.ncsu.edu/ Expertiza]<br /> #[https://github.com/expertiza/expertiza Expertiza GitHub]<br /> #[https://github.com/piyushtiw/expertiza/pull/14/files#diff-b41fa84d1ee0c03c4e301f977fbe453d Pull Request to Merge]<br /> #[http://152.7.98.234:8080/ Deployed Changes Userid - instructor6 and Password - password]<br /> #[https://github.com/piyushtiw/expertiza/projects/2 GitHub Project Board]</div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=File:Questionnaire_edit.png&diff=126973 2019-11-03T19:21:59Z

<p>Ggarima: </p> <hr /> <div></div>

Ggarima https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2019_-_E1946._Refactor_Questionnaire_controller&diff=126971 2019-11-03T19:18:09Z

<p>Ggarima: </p> <hr /> <div>This page provides a description of the Expertiza based OSS project. <br /> <br /> <br /> __TOC__<br /> <br /> <br /> ==About Expertiza==<br /> <br /> [http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.<br /> <br /> ==About Questionnaire Controller==<br /> <br /> Questionnaire is the superclass for all kinds of questionnaires and rubrics, rubrics is used for evaluating submissions and teammate contributions, and taking quizzes and surveys. All of these are subclasses of Questionnaire. This controller is used for creating, displaying, and managing Questionnaires. Different type of questionnaire can be created in Expertiza like Review, Metareview, Teammate review, Quiz Questionnaire, Global Survey, Course Survey and many more. This Controller is widely used and malfunctions can cause many issues in different parts of the system.<br /> <br /> Below is screenshot of questionnaire on expertiza. It shows all the kinds of questionnaire we can create on expertiza. <br /> <br /> [[File:Questionnaire_1.png]]<br /> <br /> Below is screenshot of all the review questionnaire we have created till now. We can edit, delete and do many other operations on questionnaire.<br /> <br /> [[File:Questionnaire_2.png]]<br /> <br /> Below is screenshot which shows how we can edit any questionnaire. <br /> <br /> [[File:Questionnaire_3.png]]<br /> <br /> ==Why Refactor Questionnaire Controller==<br /> <br /> In Questionnaire controller below are some of the problems which needs refactoring: <br /> <br /> * Renaming the methods breaking Rubys naming conventions. <br /> * Refactoring the methods doing multiple tasks and breaking them in different modules.<br /> * Reducing the length of methods longer than 50 lines of code.<br /> * Removing the string literal values used in controller.<br /> * Separating the business logic from controller and putting it in method.<br /> * Remove variables behaving same as ruby's given functionality.<br /> * Commenting the code properly for easy understanding.<br /> <br /> ==Files Modified==<br /> <br /> Below are the five file we changed as part of refactoring<br /> <br /> =====Questionnaire Controller===== <br /> This is the questionnaires_controller.rb which handles all the CRUD operation performed on any kind of questionnaire - review or surveys, add weightage to all questions, selecting type of questions. This controller holds the major part of work done for creating questions. Creating of questionnaire was one method which was extremely complicated and not well commented about what is going on. Multiple things were done in just one method which we broke in modules doing that specific task. This controller was holding the business logic as well, which we can move to model. Variables were created separate to get value from UI. At many places string literals were being hardcoded, which were made as constants.<br /> =====Questionnaire Model=====<br /> This is the questionnaire.rb model file and we have added self method in it, which will create questionnaire object for us and we will get that object in controller and process it in controller. <br /> =====Questionnaire Spec=====<br /> This is the questionnaire_controller_spec.rb file and we have changed this file in order to test the changes we have made in Questionnaire controller.<br /> =====Quiz Questionnaire Controller=====<br /> This file is quiz_questionnaire_controller.rb and was calling multiple methods of quiz questionnaire by passing questionnaire id as parameter which we have removed. <br /> =====Quiz Questionnaire Spec=====<br /> This is quiz_questionnaire_spec.rb was changed as we have removed questionnaire ID from methods in Quiz Questionnaire controller.<br /> <br /> ==User Stories==<br /> <br /> We have used Github project board to keep track of work that needs to be refactored. Below were the user stories that we have created: <br /> <br /> * '''US1''' - As a developer i want to analyze create questionnaire so that i can refactor and break it into modules.<br /> * '''US2''' - As a developer i want to refactor the create_questionnaire method by giving it meaningful name and improving code so that it does not conflict with ruby naming standard.<br /> * '''US3''' - As a developer i want to remove questionnaire_id with params[:id] so that we can remove unnecessary variables.<br /> * '''US4''' - As a developer i want to remove all hardcoded values of alternatives, min label and max label and put them in literals, so that code can be aligned to coding standards.<br /> * '''US5''' - As a developer i want to analyse why Questionnaire is being checked as QuizQuestionnaire multiple times and functionality is being changed, so that we can make quiz questionnaire same as rest.<br /> * '''US6''' - As a developer i want to run rspecs in Questionnaire spec to so that i can make sure the changes made are working correct.<br /> * '''US7''' - As a developer i want to run rspecs in Quiz Questionnaire spec to so that i can make sure the changes made are working correct.<br /> <br /> ==Refactoring==<br /> <br /> =====Refactor Create Method===== <br /> This method was in questionnaires_controller.rb<br /> Create method was very long in Questionnaire controller and was not self explanatory, number of characters in one line is more than 80 and cant be seen in one window.<br /> '''Before Refactoring'''<br /> &lt;pre&gt;<br /> def create<br /> if params[:questionnaire][:name].blank?<br /> flash[:error] = 'A rubric or survey must have a title.'<br /> redirect_to controller: 'questionnaires', action: 'new', model: params[:questionnaire][:type], private: params[:questionnaire][:private]<br /> else<br /> questionnaire_private = params[:questionnaire][:private] == 'true'<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> begin<br /> @questionnaire = Object.const_get(params[:questionnaire][:type]).new if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> begin<br /> @questionnaire.private = questionnaire_private<br /> @questionnaire.name = params[:questionnaire][:name]<br /> @questionnaire.instructor_id = session[:user].id<br /> @questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> @questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> @questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> # E1903 : We are not sure of other type of cases, so have added a if statement. If there are only 5 cases, remove the if statement<br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> @questionnaire.display_type = display_type<br /> @questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> @questionnaire.save<br /> # Create node<br /> tree_folder = TreeFolder.where(['name like ?', @questionnaire.display_type]).first<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: @questionnaire.id, type: 'QuestionnaireNode')<br /> flash[:success] = 'You have successfully created a questionnaire!'<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> redirect_to controller: 'questionnaires', action: 'edit', id: @questionnaire.id<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> In this user story we created self method in questionnaire model which will create questionnaire object and pass it in controller. Self method was divided in to two different modules which we then called into self. <br /> <br /> Method create_questionnaire_node(questionnaire) - This method will create a Tree node for new questionnaire in Expertiza&lt;br/&gt;<br /> &lt;pre&gt;<br /> # This method is used to create Treenode for newly created questionnaire<br /> def create_questionnaire_node(questionnaire)<br /> tree_folder = TreeFolder.where(['name like ?', questionnaire.display_type]).first<br /> <br /> if tree_folder.present?<br /> parent = FolderNode.find_by(node_object_id: tree_folder.id)<br /> QuestionnaireNode.create(parent_id: parent.id, node_object_id: questionnaire.id, type: 'QuestionnaireNode')<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> Method display_type_for_questionnaire(params) - This method will tell us about display type for new questionnaire in Expertiza&lt;br/&gt;<br /> <br /> &lt;pre&gt;<br /> # Displaying the newly created questionnaire<br /> def display_type_for_questionnaire(params)<br /> display_type = params[:questionnaire][:type].split('Questionnaire')[0]<br /> <br /> if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey].include?(display_type)<br /> display_type = (display_type.split /(?=[A-Z])/).join(&quot;%&quot;)<br /> end<br /> <br /> display_type<br /> end<br /> &lt;/pre&gt;<br /> <br /> This method below will be the main method for creating the questionnaire object and will call the two method we have written above. <br /> Self - Assigning all variable values from UI into questionnaire object + create_questionnaire_node(questionnaire) + display_type_for_questionnaire(params)<br /> <br /> &lt;pre&gt;<br /> # This method will create a questionnaire object and will be called from controller. <br /> class &lt;&lt; self<br /> def create_new_questionnaire_obj(params, session)<br /> # Assigning values passed from UI in params[:id] to questionnaire object<br /> if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:questionnaire][:type]<br /> questionnaire = Object.const_get(params[:questionnaire][:type]).new <br /> questionnaire.private = params[:questionnaire][:private] == 'true'<br /> questionnaire.name = params[:questionnaire][:name]<br /> questionnaire.instructor_id = session[:user].id<br /> questionnaire.min_question_score = params[:questionnaire][:min_question_score]<br /> questionnaire.max_question_score = params[:questionnaire][:max_question_score]<br /> questionnaire.type = params[:questionnaire][:type]<br /> # Zhewei: Right now, the display_type in 'questionnaires' table and name in 'tree_folders' table are not consistent.<br /> # In the future, we need to write migration files to make them consistency.<br /> questionnaire.display_type = display_type_for_questionnaire(params)<br /> questionnaire.instruction_loc = Questionnaire::DEFAULT_QUESTIONNAIRE_URL<br /> <br /> if questionnaire.save<br /> create_questionnaire_node(questionnaire)<br /> end<br /> # returning the questionnaire object to calling method create in controller<br /> questionnaire<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Refactor Create Questionnaire Method===== <br /> <br /> This method was in questionnaires_controller.rb and in this user story after deep analysis of create_questionnaire method, we found that this method has not been called anywhere so we have '''removed''' this method from the questionnaire controller. <br /> <br /> =====Remove Unnecessary Variables=====<br /> <br /> As a part of this user story we have removed unnecessary variables in questionnaires_controller.rb file. In this file methods like add_new_questions, save_all_questions, save_questions, save_new_questions, delete_questions, local variable questionnaire_id was passed as a method argument which is not actually required since this value can be fetched from class variable @questionnaire.id or from params[:id]. So, this variable was unnecessary. Below is the one of the methods named save_all_questions which was using questionnaire_id as method parameter and we refactored.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to save all questions in current questionnaire.<br /> def save_all_questions<br /> questionnaire_id = params[:id]<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif !questionnaire_id.nil?<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> &lt;pre&gt;<br /> def save_all_questions<br /> begin<br /> if params[:save]<br /> params[:question].each_pair do |k, v|<br /> @question = Question.find(k)<br /> # example of 'v' value<br /> # {&quot;seq&quot;=&gt;&quot;1.0&quot;, &quot;txt&quot;=&gt;&quot;WOW&quot;, &quot;weight&quot;=&gt;&quot;1&quot;, &quot;size&quot;=&gt;&quot;50,3&quot;, &quot;max_label&quot;=&gt;&quot;Strong agree&quot;, &quot;min_label&quot;=&gt;&quot;Not agree&quot;}<br /> v.each_pair do |key, value|<br /> @question.send(key + '=', value) if @question.send(key) != value<br /> end<br /> <br /> @question.save<br /> flash[:success] = 'All questions have been successfully saved!'<br /> end<br /> end<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> <br /> if params[:view_advice]<br /> redirect_to controller: 'advice', action: 'edit_advice', id: params[:id]<br /> elsif params[:id].present?<br /> redirect_to edit_questionnaire_path(params[:id])<br /> end<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Hardcoded String Literals=====<br /> <br /> As a part of this user story we have made changes in questionnaires_controller.rb file. Few methods have values directly hardcoded in code, which does not justify good coding standard. To clean up this code we used constant variables which also clearly mention what value is being set by this variable. Refactoring was done in method like add_new_questions.<br /> <br /> '''Before Refactoring'''<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> questionnaire_id = params[:id] unless params[:id].nil?<br /> num_of_existed_questions = Questionnaire.find(questionnaire_id).questions.size<br /> ((num_of_existed_questions + 1)..(num_of_existed_questions + params[:question][:total_num].to_i)).each do |i|<br /> question = Object.const_get(params[:question][:type]).create(txt: '', questionnaire_id: questionnaire_id, seq: i, type: params[:question][:type], break_before: true)<br /> if question.is_a? ScoredQuestion<br /> question.weight = 1<br /> question.max_label = 'Strongly agree'<br /> question.min_label = 'Strongly disagree'<br /> end<br /> question.size = '50, 3' if question.is_a? Criterion<br /> question.alternatives = '0|1|2|3|4|5' if question.is_a? Dropdown<br /> question.size = '60, 5' if question.is_a? TextArea<br /> question.size = '30' if question.is_a? TextField<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(questionnaire_id.to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> '''After Refactoring'''<br /> <br /> Constants created were: <br /> <br /> &lt;pre&gt;<br /> QUESTION_MIN_SCORE = 0<br /> QUESTION_MAX_SCORE = 1<br /> QUESTION_MAX_LABEL = 'Strongly agree'<br /> QUESTION_MIN_LABEL = 'Strongly disagree'<br /> QUESTION_CRITERION_SIZE = '50, 3'<br /> DROPDOWN_SCALE = '0|1|2|3|4|5'<br /> TEXT_AREA_SIZE = '60, 5'<br /> TEXT_FIELD_SIZE = '30'<br /> &lt;/pre&gt;<br /> <br /> We refactored the above method by making the constants and using them instead of just passing literals. We have also improved the logic by using the better conditions and variables in method.<br /> <br /> &lt;pre&gt;<br /> # Zhewei: This method is used to add new questions when editing questionnaire.<br /> def add_new_questions<br /> num_of_existed_questions = Questionnaire.find(params[:id]).questions.size<br /> question_nums =params[:question][:total_num].to_i<br /> total_question_nums = ((num_of_existed_questions + 1)..(num_of_existed_questions + question_nums))<br /> <br /> total_question_nums.each do |i|<br /> question = Object.const_get(params[:question][:type]).create(<br /> txt: '',<br /> questionnaire_id: params[:id],<br /> seq: i,<br /> type: params[:question][:type],<br /> break_before: true<br /> )<br /> if question.is_a? ScoredQuestion<br /> question.weight = MAXIMUM_QUESTION_SCORE<br /> question.min_label = QUESTION_MIN_LABEL<br /> question.max_label = QUESTION_MAX_LABEL<br /> end<br /> <br /> question.alternatives = DROPDOWN_SCALE if question.is_a? Dropdown<br /> question.size = question_size(question)<br /> begin<br /> question.save<br /> rescue StandardError<br /> flash[:error] = $ERROR_INFO<br /> end<br /> end<br /> redirect_to edit_questionnaire_path(params[:id].to_sym)<br /> end<br /> &lt;/pre&gt;<br /> <br /> =====Remove Unnecessary Checks=====<br /> <br /> In few methods like save_questions checks like “@questionnaire.id if !@questionnaire.id.nil? and @questionnaire.id &gt; 0” are added. These kind of checks are unnecessary because since value of questionnaire.id will be present is @questionnaire class variable. To clear up such code we have removed unnecessary check. <br /> <br /> =====Update Questionnaire Spec=====<br /> <br /> There is an extra method in Questionnaire controller which is not being used any where in the application so we have removed that method. We need to delete the test for the same and this has been done in this file only.<br /> <br /> =====Update Quiz Questionnaire Spec=====<br /> <br /> We have removed extra arguments passed in function call which are not required. To pass the test for the above changes we have removed arguments in the method call.<br /> <br /> ==Testing==<br /> <br /> Our task was refactoring the controller so we have mainly focused on to pass the tests which are already written. In the refactoring we have added the methods that are private so according the Messages sent to self should not be tested behaviour we have not added extra tests.<br /> <br /> ==LoopHoles== <br /> <br /> In several places begin and rescue statement are used without properly understanding the functionality. Due to this critical error messages are lost and debugging those error would be difficult. To fix this proper error log is added and begin rescue is removed.<br /> <br /> ==Team==<br /> =====Mentor===== <br /> Prof. Edward Gehringer<br /> =====Members===== <br /> * Garima Garima, Ggarima<br /> * Bharat Bhardwaj, Bbhardw<br /> * Piyush Tiwari, Ptiwari<br /> <br /> ==References==<br /> <br /> #[https://expertiza.ncsu.edu/ Expertiza]<br /> #[https://github.com/expertiza/expertiza Expertiza GitHub]<br /> #[https://github.com/piyushtiw/expertiza/pull/14/files#diff-b41fa84d1ee0c03c4e301f977fbe453d Pull Request to Merge]<br /> #[http://152.7.98.234:8080/ Deployed Changes Userid - instructor6 and Password - password]<br /> #[https://github.com/piyushtiw/expertiza/projects/2 GitHub Project Board]</div>

Ggarima