Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2023 - E2341. UI for Participants.rb

2023-04-13T01:12:02Z

Kjayesh: /* About */

== About ==
The aim of Program 4 is to create a UI for participants.rb using React. There are totally 4 main views to be implemented. They are:

1. participants.js 
2. createParticipants.js 
3. updateParticipants.js 
4. deleteParticipants.js 

This is the design diagram for the UI implementation:

[[File:designDiagram.png | 1000px]]

== Design ==

=== participants.js (Manage participants) ===

This is the main page that allows the user to manage participants' information. All the other pages like create participants, update participants, and delete participants can be accessed from this page.

We intend to create the Manage Participants page something like this:

[[File:ManageParticipant.png | 1000px]]

=== createParticipants.js ===

In the create participants popup window, the user will be able to create a participant by entering his/her username, first name, last name, email, role, email preferences, institution, and the grade of the participant for a course or a particular assignment.

We have planned to create the page in this manner.

[[File:CreateParticipant.png | 1000px]]

=== updateParticipants.rb ===

On this page, the user will be able to update the details of an existing participant. We intend to create the update participants page something like this:

[[File:UpdateParticipant.png | 1000px]]

=== deleteParticpants.rb ===

By clicking the delete participant option, the user will be prompted with a popup window that asks for confirmation from the user. Doing this will completely delete the participant from the records if they are not associated elsewhere (as a reviewer or reviewee for another assignment).

This is how we plan to design this popup window.

[[File:deleteParticipant.png | 1000px]]

== Database ==

Since we do not have a database to implement in the reimplementation_front_end GitHub repo, we have to mock the databases. This is done by creating a JSON file where all the columns related to participants are entered.

== Test Plan ==

Apart from testing the pages manually, there is no need of writing automated tests for this program.

=== participants.js(Manage Participants) ===

We will have to ensure that view of this appears properly, with all the necessary options (delete, edit, create) for the participants. We will have to also make sure that the details are displayed in table format as shown in the figure. The search bar, next page and other options should also be verified accordingly.

=== createparticipants.js ===

1. Verify that the create participant popup window is displayed when the user clicks on the "Create Participant" icon button on the top right corner.

2. Check that all the required fields are present and labelled appropriately.

3. Verify that the user is able to select a role from the dropdown list.

4. Verify if the checkboxes for email preferences are working correctly.

5. Verify that the user is able to select an institution from the dropdown list.

6. Test the close button to ensure that the popup window closes without creating a new participant.

7. Verify that the create participant popup window closes after successful participant creation.

=== editparticipants.js ===

1. Verify that the edit participant popup window is displayed when the user clicks on the "Edit Participant" icon button for each user.

2. Check that all the required fields are present and labelled appropriately.

3. Verify that the user is able to change the selected role from the dropdown list.

4. Verify if the user can edit the checkboxes for email preferences.

5. Verify that the user is able to change the selected institution from the dropdown list.

6. Test the close button to ensure that the popup window closes without editing a new participant.

7. Verify that the create participant popup window closes after a successful participant update.

=== deleteparticipant.js ===

1. Verify that the delete pop-up window appears when the user clicks the delete icon button.

2. Verify that the delete pop-up window closes when the user clicks on the "close".

3. Verify that the delete pop-up window closes after a successful participant deletion.

== Relevant Links ==
GitHub repository: https://github.com/amarthyasa/reimplementation-front-end 
Pull request: https://github.com/expertiza/reimplementation-front-end/pull/5

== Team ==
=== Mentor ===
Rucha Kolekar 
=== Student Team ===
Amarthya Sivakumar Annu (asivaku5@ncsu.edu) 
Ajay Krishna Raveendar (araveen@ncsu.edu) 
Kiron Jayesh (kjayesh@ncsu.edu)

File:DesignDiagram.png

2023-04-13T01:10:50Z

Kjayesh:

CSC/ECE 517 Spring 2023 - E2341. UI for Participants.rb

2023-04-13T00:21:47Z

Kjayesh: /* Relevant Links */

== About ==
The aim of Program 4 is to create a UI for participants.rb using React. There are totally 4 main views to be implemented. They are:

1. participants.js 
2. createParticipants.js 
3. updateParticipants.js 
4. deleteParticipants.js 

== Design ==

=== participants.js (Manage participants) ===

This is the main page that allows the user to manage participants' information. All the other pages like create participants, update participants, and delete participants can be accessed from this page.

We intend to create the Manage Participants page something like this:

[[File:ManageParticipant.png | 1000px]]

=== createParticipants.js ===

In the create participants popup window, the user will be able to create a participant by entering his/her username, first name, last name, email, role, email preferences, institution, and the grade of the participant for a course or a particular assignment.

We have planned to create the page in this manner.

[[File:CreateParticipant.png | 1000px]]

=== updateParticipants.rb ===

On this page, the user will be able to update the details of an existing participant. We intend to create the update participants page something like this:

[[File:UpdateParticipant.png | 1000px]]

=== deleteParticpants.rb ===

By clicking the delete participant option, the user will be prompted with a popup window that asks for confirmation from the user. Doing this will completely delete the participant from the records if they are not associated elsewhere (as a reviewer or reviewee for another assignment).

This is how we plan to design this popup window.

[[File:deleteParticipant.png | 1000px]]

== Database ==

Since we do not have a database to implement in the reimplementation_front_end GitHub repo, we have to mock the databases. This is done by creating a JSON file where all the columns related to participants are entered.

== Test Plan ==

Apart from testing the pages manually, there is no need of writing automated tests for this program.

=== participants.js(Manage Participants) ===

We will have to ensure that view of this appears properly, with all the necessary options (delete, edit, create) for the participants. We will have to also make sure that the details are displayed in table format as shown in the figure. The search bar, next page and other options should also be verified accordingly.

=== createparticipants.js ===

1. Verify that the create participant popup window is displayed when the user clicks on the "Create Participant" icon button on the top right corner.

2. Check that all the required fields are present and labelled appropriately.

3. Verify that the user is able to select a role from the dropdown list.

4. Verify if the checkboxes for email preferences are working correctly.

5. Verify that the user is able to select an institution from the dropdown list.

6. Test the close button to ensure that the popup window closes without creating a new participant.

7. Verify that the create participant popup window closes after successful participant creation.

=== editparticipants.js ===

1. Verify that the edit participant popup window is displayed when the user clicks on the "Edit Participant" icon button for each user.

2. Check that all the required fields are present and labelled appropriately.

3. Verify that the user is able to change the selected role from the dropdown list.

4. Verify if the user can edit the checkboxes for email preferences.

5. Verify that the user is able to change the selected institution from the dropdown list.

6. Test the close button to ensure that the popup window closes without editing a new participant.

7. Verify that the create participant popup window closes after a successful participant update.

=== deleteparticipant.js ===

1. Verify that the delete pop-up window appears when the user clicks the delete icon button.

2. Verify that the delete pop-up window closes when the user clicks on the "close".

3. Verify that the delete pop-up window closes after a successful participant deletion.

== Relevant Links ==
GitHub repository: https://github.com/amarthyasa/reimplementation-front-end 
Pull request: https://github.com/expertiza/reimplementation-front-end/pull/5

== Team ==
=== Mentor ===
Rucha Kolekar 
=== Student Team ===
Amarthya Sivakumar Annu (asivaku5@ncsu.edu) 
Ajay Krishna Raveendar (araveen@ncsu.edu) 
Kiron Jayesh (kjayesh@ncsu.edu)

CSC/ECE 517 Spring 2023 - E2341. UI for Participants.rb

2023-04-07T04:20:29Z

Kjayesh:

CSC/ECE 517 Spring 2023 - E2341. UI for Participants.rb

2023-04-07T04:15:13Z

Kjayesh:

CSC/ECE 517 Spring 2023 - E2341. UI for Participants.rb

2023-04-07T04:08:55Z

Kjayesh: /* Design */

CSC/ECE 517 Spring 2023 - E2341. UI for Participants.rb

2023-04-07T04:00:07Z

Kjayesh: /* createParticipants.js */

CSC/ECE 517 Spring 2023 - E2341. UI for Participants.rb

2023-04-07T03:58:35Z

Kjayesh:

File:UpdateParticipant.png

2023-04-07T03:49:44Z

Kjayesh:

File:DeleteParticipant.png

2023-04-07T03:49:03Z

Kjayesh:

File:CreateParticipant.png

2023-04-07T03:48:47Z

Kjayesh:

File:ManageParticipant.png

2023-04-07T03:48:29Z

Kjayesh:

CSC/ECE 517 Spring 2023 - E2341. UI for Participants.rb

2023-04-07T03:30:38Z

Kjayesh:

== Design ==

== Team ==
=== Mentor ===
Rucha Kolekar 
=== Student Team ===
Amarthya Sivakumar Annu (asivaku5@ncsu.edu) 
Ajay Krishna Raveendar (araveen@ncsu.edu) 
Kiron Jayesh (kjayesh@ncsu.edu)

CSC/ECE 517 Spring 2023

2023-04-07T03:26:52Z

Kjayesh: /* OSS Projects */

== OSS Projects ==
[[CSC/ECE 517 Spring_2023 -E2306. Refactor user_controller.rb, user.rb and its child classes]]

[[CSC/ECE 517 Spring_2023 - E2320. Reimplement the Question hierarchy]]

[[CSC/ECE 517 Spring_2023 - E2312 + E2313. Reimplement response.rb and responses_controller.rb]]

[[CSC/ECE 517 Spring_2023 - NTNX-1. Support provisioning MongoDb via NDB Kubernetes Operator]]

[[CSC/ECE 517 Spring_2023 - E2316. Reimplement sign_up_sheet_controller.rb]]

[[CSC/ECE 517 Spring_2023 - E2315. Reimplement signed_up_team.rb, sign_up_topic.rb, sign_up_sheet.rb]]

[[CSC/ECE 517 Spring_2023 - E2340. Reimplement signed_up_team.rb, sign_up_topic.rb, sign_up_sheet.rb (Project 4)]]

[[CSC/ECE 517 Spring_2023 - E2323. Refactor DueDate functionality from assignment.rb]]

[[CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb]]

[[CSC/ECE 517 Spring 2023 - E2314. Reimplement the response map hierarchy]]

[[CSC/ECE 517 Spring 2023- NTNX-4. Extend NDB operator provision postregresql aws]]

[[CSC/ECE 517 Spring 2023 - E2321. Reimplement QuestionnairesController and QuestionsController]]

[[CSC/ECE 517 Spring 2023 - E2305. Grading audit trail]]

[[CSC/ECE 517 Spring 2023 - E2309. Refactor Node model and its subclasses]]

[[CSC/ECE 517 Spring 2023 - NTNX-2. Support provisioning mySQL databases via NDB Kubernetes Operator]]

[[CSC/ECE 517 Spring 2023 - E2300. Refactor E1858. Github metrics integration]]

[[CSC/ECE 517 Sping 2023 - E2322: Refactor Questionnaire View to display Bookmark Rating]]

[[CSC/ECE 517 Spring 2023 - NTNX-3. Refactor models to keep profiles (software, compute, network, etc) as optional and use default if not specified]]

[[CSC/ECE_517_Spring_2023_-_E2301._Refactor_review_maping_helper]]

[[CSC/ECE_517_Spring_2023_-_E2337._Reimplement_node_hierarchy]]

[[CSC/ECE_517_Spring_2023_-E2339._Reimplement signed_up_teams_controller and sign_up_topics_controller.rb]]

[[CSC/ECE_517_Spring_2023_-_E2320._Reimplement the Question Hierarchy]]

[[CSC/ECE_517_Spring_2023 - E2341. UI for Participants.rb]]

CSC/ECE 517 Spring 2023 - E2341. UI for Participants.rb

2023-04-07T03:24:54Z

Kjayesh: Created page with "== Team == === Mentor === Rucha Kolekar === Student Team === Amarthya Sivakumar Annu (asivaku5@ncsu.edu) Ajay Krishna Raveendar (araveen@ncsu.edu) Kiron Jayesh..."

== Team ==
=== Mentor ===
Rucha Kolekar 
=== Student Team ===
Amarthya Sivakumar Annu (asivaku5@ncsu.edu) 
Ajay Krishna Raveendar (araveen@ncsu.edu) 
Kiron Jayesh (kjayesh@ncsu.edu)

CSC/ECE 517 Spring 2023

2023-04-07T03:22:10Z

Kjayesh: /* OSS Projects */

CSC/ECE 517 Spring 2023

2023-04-07T03:21:37Z

Kjayesh: /* OSS Projects */

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-03-28T03:14:19Z

Kjayesh: /* Future Work */

This wiki page is for the description of changes made under E2317 OSS assignment for Spring 2023, CSC/ECE 517

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. It is a web application which is maintained collectively by NC State faculty and students which allows instructors to create new assignments and customize new or existing assignments. It also allows the instructors 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.

==Overview of the Classes==
===participant.rb===
The participant.rb is a model class that has many associations with other models. There are many methods present in it such as fullname, name, team and handle. There is a method called delete which checks for any associations before performing the delete operation. The other methods include topic_name, mail_assigned_reviewers, able_to_review, email, authorization and self.sort_by_name. There is one more method self.export that returns the information of the participant as a CSV file.

==Backgroud of the Project==
The participant.rb model has many new changes to be implemented. The reimplementation has to make sense and while checking the original model, we realised that some of the methods were irrelevant to participants model and that it has to be implemented in some other model. The changes mainly dealt with removing, merging and replacing methods to segregate methods with a single functionality relevant to participants model. Tests were written for all of the methods that were introduced and modified. Existing tests for the methods that were unchanged were run to ensure proper functioning of the model. Comments are added to each method to enhance readability. Further information about the reimplementations are discussed below.

==Design Decisions==
The following changes were reimplemented in the participant.rb

{| class="wikitable" style="margin-left:40px"
|-
! Tasks !! Status !! Testing
|-
| Replaced force_delete method with leave_team method
|| Implemented || Completed
|-
| mail_assigned_reviewers method was removed || Implemented || N/A
|-
| able_to_review method was eliminated || Implemented || N/A
|-
| email method was removed || Implemented || N/A
|-
| Merged export and export_fields methods || Implemented || To be completed
|}

=== Replaced force_delete Method with leave_team Method ===
The original 'force_delete' method would delete the participant from the team and if there is only one participant in the team then it would delete the team.
[[File:E2317_force_delete.jpg | 800px]]

A new method 'leave_team' was introduced in place of 'force_delete' as 'force_delete' method is supposed to be present in the teams.rb and not participant.rb. The difference between force_delete method and this is that even if there is only one participant it wouldn't delete the team.

[[File:E2317_leave_team.jpg | 800px]]

=== mail_assigned_reviewers Method was Removed ===
The method 'Mail_assigned_reviewers' is responsible for sending an email to the assigned reviewer whenever a new submission is made. It would be more appropriate for this method to be included in teams.rb rather than participant.rb. Hence, this method was removed.

=== able_to_review Method was Removed ===
'able_to_review' method is just using can_review value. This method can be eliminated.

=== email Method was Removed ===
'email' method was removed as it was not required.

=== Merged export and export_fields Methods ===
We didn't implement this task as merging two functions became a hassle for debugging and testing and fixing errors present in the code. Instead, it is generally considered good programming practice to break down large functions into smaller, more manageable ones. This principle is commonly known as the "Single Responsibility Principle," which states that a function or module should have only one reason to change. By breaking down a large function into smaller functions, made our code more modular and easier to read, understand, and maintain.

==Testing Plan==

The reimplementation codebase originally used Minitest to test the included models: assignment.rb, role.rb, and user.rb. But since Expertiza was originally tested with RSpec, we used RSpec to test out model. The participants.rb contains many methods and associations with other models. Hence, to test the methods in participants, the other dependent methods have to be stubbed. To deal with the models, dummy models/dummy app can be created which will act as the associated classes. We have created all the required dummy classes by scaffolding them.

To create test fixtures and to build the required models, Factory Bot has been used. Two separate files, factories.rb and factory_bot.rb was created to build the factories.

4 participants and other required fields were created as fixtures after which the tests were written.

====Note====

The dummy classes that were created and other dependencies that were specifically installed for testing have been pushed to a different branch to not let the main codebase clutter with empty models.

To run the tests, kindly pull from the [https://github.com/amarthyasa/reimplementation-back-end/tree/testing_files testing_files] branch of the repository and run bundle install to install dependencies like RSpec and Factory Bot.

====Tests====

{| class="wikitable" style="margin-left:40px"
|-
! Test No. !! Description
|-
| 1 || Tests if the team method returns the team of the participant
|-
| 2 || Tests if the leave_team method deletes a participant if no associations exist and force is nil
|-
| 3 || Tests if the leave_team method deletes a participant if no associations exist and force is true
|-
| 4 || Tests if the leave_team method deletes a participant with associations and force is true and there are multiple team users
|-
| 5 || Tests if the name method returns the name of the participant
|-
| 6 || Tests if the fullname method returns the full name of the participant
|-
| 7 || Tests if the handle method returns the handle of the participant
|-
| 8 || Tests if the sort_by_name method returns a sorted list of participants in alphabetical order
|-
| 9 || Tests if the topic_name method returns the participant topic name when nil
|-
| 10 || Tests if the topic_name method returns the participant topic name when not nil.
|-
| 11 || Tests if the authorization method returns participant when no arguments are passed.
|-
| 12 || Tests if the authorization method returns reader when no arguments are passed.
|-
| 13 || Tests if the authorization method returns submitter when no arguments are passed.
|-
| 14 || Tests if the authorization method returns reviewer when no arguments are passed.
|-
| 13 || Tests if the authorization method returns submitter when no arguments are passed.
|-
| 14 || Tests if the authorization method returns reviewer when no arguments are passed.
|-
| 15 ||
|-
| 16 ||

|}

The test which checks if participant and team is deleted if only one participant is on a team is deleted since that implementation has been removed from the model.

=====Test 1=====
This code is testing a method team and is expected to return the team associated with the participant. It is done by mocking the behavior of other objects that the team method relies on, specifically a user object and a team_user object. By mocking these dependencies, the test can focus on testing the behavior of the team method in isolation.

[[File:E2317_Test1.jpg | 800px]]

=====Tests 2 to 4=====
This is a set of tests for the delete method of a participant object. The first two tests check that a participant can be deleted if there are no associations, with and without the force parameter. The third test checks that a participant can be deleted even if there are associations with multiple team_users, but only if the force parameter is true. The allow method is used to set up mock behavior for the team and participant objects in the third test.

[[File:E2317_Test234.jpg | 800px]]

=====Test 5=====
This is a test block for the name method of the participant object. The test checks if calling name on a participant object returns the expected name of 'Jane'. If the method is working correctly, the test should pass.

[[File:E2317_Test5.jpg | 800px]]

=====Test 6=====
This is a test block for the fullname method of the participant object. The test checks if calling the full name on a participant object returns the expected name of 'Jane Doe'. If the method is working correctly, the test should pass.

[[File:E2317_Test6.jpg | 800px]]

=====Test 7=====

=====Test 8=====

=====Tests 9 to 10=====

=====Tests 11 to 14=====

=====Tests 15 to 16=====

==Relevant Links==

Github repository: https://github.com/amarthyasa/reimplementation-back-end/tree/main
 
Github repository branch for testing: https://github.com/amarthyasa/reimplementation-back-end/tree/testing_files
 
Pull request: https://github.com/expertiza/reimplementation-back-end/pull/5
 
Testing video: https://drive.google.com/file/d/1VXMF8dbJgjcj68Y9pRTgXg2cJrfL9-_6/view?usp=sharing

==Team==
===Mentor===
Rucha Kolekar

===Student Team===
Amarthya Sivakumar Annu (asivaku5@ncsu.edu) 
Ajay Krishna Raveendar (araveen@ncsu.edu) 
Kiron Jayesh (kjayesh@ncsu.edu)

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-03-23T02:04:01Z

Kjayesh: /* Student Team */

This wiki page is for the description of changes made under E2317 OSS assignment for Spring 2023, CSC/ECE 517

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. It is a web application which is maintained collectively by NC State faculty and students which allows instructors to create new assignments and customize new or existing assignments. It also allows the instructors 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.

==Overview of the Classes==
===participant.rb===
The participant.rb is a model class that has many associations with other models. There are many methods present in it such as fullname, name, team and handle. There is a method called delete which checks for any associations before performing the delete operation. The other methods include topic_name, mail_assigned_reviewers, able_to_review, email, authorization and self.sort_by_name. There is one more method self.export that returns the information of the participant as a CSV file.

==Backgroud of the Project==
The participant.rb model has many new changes to be implemented. The reimplementation has to make sense and while checking the original model, we realised that some of the methods were irrelevant to participants model and that it has to be implemented in some other model. The changes mainly dealt with removing, merging and replacing methods to segregate methods with a single functionality relevant to participants model. Tests were written for all of the methods that were introduced and modified. Existing tests for the methods that were unchanged were run to ensure proper functioning of the model. Comments are added to each method to enhance readability. Further information about the reimplementations are discussed below.

==Design Decisions==
The following changes were reimplemented in the participant.rb

{| class="wikitable" style="margin-left:40px"
|-
! Tasks !! Status !! Testing
|-
| Replaced force_delete method with leave_team method
|| Implemented || Completed
|-
| mail_assigned_reviewers method was removed || Implemented || N/A
|-
| able_to_review method was eliminated || Implemented || N/A
|-
| email method was removed || Implemented || N/A
|-
| Merged export and export_fields methods || Implemented || To be completed
|}

=== Replaced force_delete Method with leave_team Method ===
The original 'force_delete' method would delete the participant from the team and if there is only one participant in the team then it would delete the team.
[[File:E2317_force_delete.jpg | 800px]]

A new method 'leave_team' was introduced in place of 'force_delete' as 'force_delete' method is supposed to be present in the teams.rb and not participant.rb. The difference between force_delete method and this is that even if there is only one participant it wouldn't delete the team.

[[File:E2317_leave_team.jpg | 800px]]

=== mail_assigned_reviewers Method was Removed ===
The method 'Mail_assigned_reviewers' is responsible for sending an email to the assigned reviewer whenever a new submission is made. It would be more appropriate for this method to be included in teams.rb rather than participant.rb. Hence, this method was removed.

=== able_to_review Method was Removed ===
'able_to_review' method is just using can_review value. This method can be eliminated.

=== email Method was Removed ===
'email' method was removed as it was not required.

=== Merged export and export_fields Methods ===
'export' and 'export_fields' methods can be merged to form a single method under 'export'.

Before merging:

[[File:E2317_export_exportfields.jpg | 800px]]

After merging:

[[File:E2317_merge.jpg | 800px]]

==Testing Plan==

The reimplementation codebase originally used Minitest to test the included models: assignment.rb, role.rb, and user.rb. But since Expertiza was originally tested with RSpec, we used RSpec to test out model. The participants.rb contains many methods and associations with other models. Hence, to test the methods in participants, the other dependent methods have to be stubbed. To deal with the models, dummy models/dummy app can be created which will act as the associated classes. We have created all the required dummy classes by scaffolding them.

To create test fixtures and to build the required models, Factory Bot has been used. Two separate files, factories.rb and factory_bot.rb was created to build the factories.

4 participants and other required fields were created as fixtures after which the tests were written.

====Note====

The dummy classes that were created and other dependencies that were specifically installed for testing have been pushed to a different branch to not let the main codebase clutter with empty models.

To run the tests, kindly pull from the [https://github.com/amarthyasa/reimplementation-back-end/tree/testing_files testing_files] branch of the repository and run bundle install to install dependencies like RSpec and Factory Bot.

====Tests====

{| class="wikitable" style="margin-left:40px"
|-
! Test No. !! Description
|-
| 1 || Tests if the team method returns the team of the participant
|-
| 2 || Tests if the leave_team method deletes a participant if no associations exist and force is nil
|-
| 3 || Tests if the leave_team method deletes a participant if no associations exist and force is true
|-
| 4 || Tests if the leave_team method deletes a participant with associations and force is true and there are multiple team users
|-
| 5 || Tests if the name method returns the name of the participant
|-
| 6 || Tests if the fullname method returns the full name of the participant
|-
| 7 || Tests if the handle method returns the handle of the participant
|-
| 8 || Tests if the sort_by_name method returns a sorted list of participants in alphabetical order
|-
| 9 || Tests if the topic_name method returns the participant topic name when nil
|-
| 10 || Tests if the topic_name method returns the participant topic name when not nil.
|-
| 11 || Tests if the authorization method returns participant when no arguments are passed.
|-
| 12 || Tests if the authorization method returns reader when no arguments are passed.
|-
| 13 || Tests if the authorization method returns submitter when no arguments are passed.
|-
| 14 || Tests if the authorization method returns reviewer when no arguments are passed.

|}

The test which checks if participant and team is deleted if only one participant is on a team is deleted since that implementation has been removed from the model.

==Future Work==

1. Testing for the merged method, export, has to be done.

2. Response method has to be tested.

==Relevant Links==

Github repository: https://github.com/amarthyasa/reimplementation-back-end/tree/main
 
Github repository branch for testing: https://github.com/amarthyasa/reimplementation-back-end/tree/testing_files
 
Pull request: https://github.com/expertiza/reimplementation-back-end/pull/5
 
Testing video:

==Team==
===Mentor===
Rucha Kolekar

===Student Team===
Amarthya Sivakumar Annu (asivaku5@ncsu.edu) 
Ajay Krishna Raveendar (araveen@ncsu.edu) 
Kiron Jayesh (kjayesh@ncsu.edu)

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-03-23T02:02:03Z

Kjayesh: /* Student Team */

This wiki page is for the description of changes made under E2317 OSS assignment for Spring 2023, CSC/ECE 517

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. It is a web application which is maintained collectively by NC State faculty and students which allows instructors to create new assignments and customize new or existing assignments. It also allows the instructors 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.

==Overview of the Classes==
===participant.rb===
The participant.rb is a model class that has many associations with other models. There are many methods present in it such as fullname, name, team and handle. There is a method called delete which checks for any associations before performing the delete operation. The other methods include topic_name, mail_assigned_reviewers, able_to_review, email, authorization and self.sort_by_name. There is one more method self.export that returns the information of the participant as a CSV file.

==Backgroud of the Project==
The participant.rb model has many new changes to be implemented. The reimplementation has to make sense and while checking the original model, we realised that some of the methods were irrelevant to participants model and that it has to be implemented in some other model. The changes mainly dealt with removing, merging and replacing methods to segregate methods with a single functionality relevant to participants model. Tests were written for all of the methods that were introduced and modified. Existing tests for the methods that were unchanged were run to ensure proper functioning of the model. Comments are added to each method to enhance readability. Further information about the reimplementations are discussed below.

==Design Decisions==
The following changes were reimplemented in the participant.rb

{| class="wikitable" style="margin-left:40px"
|-
! Tasks !! Status !! Testing
|-
| Replaced force_delete method with leave_team method
|| Implemented || Completed
|-
| mail_assigned_reviewers method was removed || Implemented || N/A
|-
| able_to_review method was eliminated || Implemented || N/A
|-
| email method was removed || Implemented || N/A
|-
| Merged export and export_fields methods || Implemented || To be completed
|}

=== Replaced force_delete Method with leave_team Method ===
The original 'force_delete' method would delete the participant from the team and if there is only one participant in the team then it would delete the team.
[[File:E2317_force_delete.jpg | 800px]]

A new method 'leave_team' was introduced in place of 'force_delete' as 'force_delete' method is supposed to be present in the teams.rb and not participant.rb. The difference between force_delete method and this is that even if there is only one participant it wouldn't delete the team.

[[File:E2317_leave_team.jpg | 800px]]

=== mail_assigned_reviewers Method was Removed ===
The method 'Mail_assigned_reviewers' is responsible for sending an email to the assigned reviewer whenever a new submission is made. It would be more appropriate for this method to be included in teams.rb rather than participant.rb. Hence, this method was removed.

=== able_to_review Method was Removed ===
'able_to_review' method is just using can_review value. This method can be eliminated.

=== email Method was Removed ===
'email' method was removed as it was not required.

=== Merged export and export_fields Methods ===
'export' and 'export_fields' methods can be merged to form a single method under 'export'.

Before merging:

[[File:E2317_export_exportfields.jpg | 800px]]

After merging:

[[File:E2317_merge.jpg | 800px]]

==Testing Plan==

The reimplementation codebase originally used Minitest to test the included models: assignment.rb, role.rb, and user.rb. But since Expertiza was originally tested with RSpec, we used RSpec to test out model. The participants.rb contains many methods and associations with other models. Hence, to test the methods in participants, the other dependent methods have to be stubbed. To deal with the models, dummy models/dummy app can be created which will act as the associated classes. We have created all the required dummy classes by scaffolding them.

To create test fixtures and to build the required models, Factory Bot has been used. Two separate files, factories.rb and factory_bot.rb was created to build the factories.

4 participants and other required fields were created as fixtures after which the tests were written.

====Note====

The dummy classes that were created and other dependencies that were specifically installed for testing have been pushed to a different branch to not let the main codebase clutter with empty models.

To run the tests, kindly pull from the [https://github.com/amarthyasa/reimplementation-back-end/tree/testing_files testing_files] branch of the repository and run bundle install to install dependencies like RSpec and Factory Bot.

====Tests====

{| class="wikitable" style="margin-left:40px"
|-
! Test No. !! Description
|-
| 1 || Tests if the team method returns the team of the participant
|-
| 2 || Tests if the leave_team method deletes a participant if no associations exist and force is nil
|-
| 3 || Tests if the leave_team method deletes a participant if no associations exist and force is true
|-
| 4 || Tests if the leave_team method deletes a participant with associations and force is true and there are multiple team users
|-
| 5 || Tests if the name method returns the name of the participant
|-
| 6 || Tests if the fullname method returns the full name of the participant
|-
| 7 || Tests if the handle method returns the handle of the participant
|-
| 8 || Tests if the sort_by_name method returns a sorted list of participants in alphabetical order
|-
| 9 || Tests if the topic_name method returns the participant topic name when nil
|-
| 10 || Tests if the topic_name method returns the participant topic name when not nil.
|-
| 11 || Tests if the authorization method returns participant when no arguments are passed.
|-
| 12 || Tests if the authorization method returns reader when no arguments are passed.
|-
| 13 || Tests if the authorization method returns submitter when no arguments are passed.
|-
| 14 || Tests if the authorization method returns reviewer when no arguments are passed.

|}

The test which checks if participant and team is deleted if only one participant is on a team is deleted since that implementation has been removed from the model.

==Future Work==

1. Testing for the merged method, export, has to be done.

2. Response method has to be tested.

==Relevant Links==

Github repository: https://github.com/amarthyasa/reimplementation-back-end/tree/main
 
Github repository branch for testing: https://github.com/amarthyasa/reimplementation-back-end/tree/testing_files
 
Pull request: https://github.com/expertiza/reimplementation-back-end/pull/5
 
Testing video:

==Team==
===Mentor===
Rucha Kolekar

===Student Team===
Amarthya Sivakumar Annu 
Ajay Krishna Raveendar 
Kiron Jayesh

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-03-23T02:01:34Z

Kjayesh:

This wiki page is for the description of changes made under E2317 OSS assignment for Spring 2023, CSC/ECE 517

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. It is a web application which is maintained collectively by NC State faculty and students which allows instructors to create new assignments and customize new or existing assignments. It also allows the instructors 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.

==Overview of the Classes==
===participant.rb===
The participant.rb is a model class that has many associations with other models. There are many methods present in it such as fullname, name, team and handle. There is a method called delete which checks for any associations before performing the delete operation. The other methods include topic_name, mail_assigned_reviewers, able_to_review, email, authorization and self.sort_by_name. There is one more method self.export that returns the information of the participant as a CSV file.

==Backgroud of the Project==
The participant.rb model has many new changes to be implemented. The reimplementation has to make sense and while checking the original model, we realised that some of the methods were irrelevant to participants model and that it has to be implemented in some other model. The changes mainly dealt with removing, merging and replacing methods to segregate methods with a single functionality relevant to participants model. Tests were written for all of the methods that were introduced and modified. Existing tests for the methods that were unchanged were run to ensure proper functioning of the model. Comments are added to each method to enhance readability. Further information about the reimplementations are discussed below.

==Design Decisions==
The following changes were reimplemented in the participant.rb

{| class="wikitable" style="margin-left:40px"
|-
! Tasks !! Status !! Testing
|-
| Replaced force_delete method with leave_team method
|| Implemented || Completed
|-
| mail_assigned_reviewers method was removed || Implemented || N/A
|-
| able_to_review method was eliminated || Implemented || N/A
|-
| email method was removed || Implemented || N/A
|-
| Merged export and export_fields methods || Implemented || To be completed
|}

=== Replaced force_delete Method with leave_team Method ===
The original 'force_delete' method would delete the participant from the team and if there is only one participant in the team then it would delete the team.
[[File:E2317_force_delete.jpg | 800px]]

A new method 'leave_team' was introduced in place of 'force_delete' as 'force_delete' method is supposed to be present in the teams.rb and not participant.rb. The difference between force_delete method and this is that even if there is only one participant it wouldn't delete the team.

[[File:E2317_leave_team.jpg | 800px]]

=== mail_assigned_reviewers Method was Removed ===
The method 'Mail_assigned_reviewers' is responsible for sending an email to the assigned reviewer whenever a new submission is made. It would be more appropriate for this method to be included in teams.rb rather than participant.rb. Hence, this method was removed.

=== able_to_review Method was Removed ===
'able_to_review' method is just using can_review value. This method can be eliminated.

=== email Method was Removed ===
'email' method was removed as it was not required.

=== Merged export and export_fields Methods ===
'export' and 'export_fields' methods can be merged to form a single method under 'export'.

Before merging:

[[File:E2317_export_exportfields.jpg | 800px]]

After merging:

[[File:E2317_merge.jpg | 800px]]

==Testing Plan==

The reimplementation codebase originally used Minitest to test the included models: assignment.rb, role.rb, and user.rb. But since Expertiza was originally tested with RSpec, we used RSpec to test out model. The participants.rb contains many methods and associations with other models. Hence, to test the methods in participants, the other dependent methods have to be stubbed. To deal with the models, dummy models/dummy app can be created which will act as the associated classes. We have created all the required dummy classes by scaffolding them.

To create test fixtures and to build the required models, Factory Bot has been used. Two separate files, factories.rb and factory_bot.rb was created to build the factories.

4 participants and other required fields were created as fixtures after which the tests were written.

====Note====

The dummy classes that were created and other dependencies that were specifically installed for testing have been pushed to a different branch to not let the main codebase clutter with empty models.

To run the tests, kindly pull from the [https://github.com/amarthyasa/reimplementation-back-end/tree/testing_files testing_files] branch of the repository and run bundle install to install dependencies like RSpec and Factory Bot.

====Tests====

{| class="wikitable" style="margin-left:40px"
|-
! Test No. !! Description
|-
| 1 || Tests if the team method returns the team of the participant
|-
| 2 || Tests if the leave_team method deletes a participant if no associations exist and force is nil
|-
| 3 || Tests if the leave_team method deletes a participant if no associations exist and force is true
|-
| 4 || Tests if the leave_team method deletes a participant with associations and force is true and there are multiple team users
|-
| 5 || Tests if the name method returns the name of the participant
|-
| 6 || Tests if the fullname method returns the full name of the participant
|-
| 7 || Tests if the handle method returns the handle of the participant
|-
| 8 || Tests if the sort_by_name method returns a sorted list of participants in alphabetical order
|-
| 9 || Tests if the topic_name method returns the participant topic name when nil
|-
| 10 || Tests if the topic_name method returns the participant topic name when not nil.
|-
| 11 || Tests if the authorization method returns participant when no arguments are passed.
|-
| 12 || Tests if the authorization method returns reader when no arguments are passed.
|-
| 13 || Tests if the authorization method returns submitter when no arguments are passed.
|-
| 14 || Tests if the authorization method returns reviewer when no arguments are passed.

|}

The test which checks if participant and team is deleted if only one participant is on a team is deleted since that implementation has been removed from the model.

==Future Work==

1. Testing for the merged method, export, has to be done.

2. Response method has to be tested.

==Relevant Links==

Github repository: https://github.com/amarthyasa/reimplementation-back-end/tree/main
 
Github repository branch for testing: https://github.com/amarthyasa/reimplementation-back-end/tree/testing_files
 
Pull request: https://github.com/expertiza/reimplementation-back-end/pull/5
 
Testing video:

==Team==
===Mentor===
Rucha Kolekar

===Student Team===
Amarthya Sivakumar Annu
Ajay Krishna Raveendar
Kiron Jayesh

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-03-23T01:58:25Z

Kjayesh: /* Relevant Links */

This wiki page is for the description of changes made under E2317 OSS assignment for Spring 2023, CSC/ECE 517

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. It is a web application which is maintained collectively by NC State faculty and students which allows instructors to create new assignments and customize new or existing assignments. It also allows the instructors 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.

==Overview of the Classes==
===participant.rb===
The participant.rb is a model class that has many associations with other models. There are many methods present in it such as fullname, name, team and handle. There is a method called delete which checks for any associations before performing the delete operation. The other methods include topic_name, mail_assigned_reviewers, able_to_review, email, authorization and self.sort_by_name. There is one more method self.export that returns the information of the participant as a CSV file.

==Backgroud of the Project==
The participant.rb model has many new changes to be implemented. The reimplementation has to make sense and while checking the original model, we realised that some of the methods were irrelevant to participants model and that it has to be implemented in some other model. The changes mainly dealt with removing, merging and replacing methods to segregate methods with a single functionality relevant to participants model. Tests were written for all of the methods that were introduced and modified. Existing tests for the methods that were unchanged were run to ensure proper functioning of the model. Comments are added to each method to enhance readability. Further information about the reimplementations are discussed below.

==Design Decisions==
The following changes were reimplemented in the participant.rb

{| class="wikitable" style="margin-left:40px"
|-
! Tasks !! Status !! Testing
|-
| Replaced force_delete method with leave_team method
|| Implemented || Completed
|-
| mail_assigned_reviewers method was removed || Implemented || N/A
|-
| able_to_review method was eliminated || Implemented || N/A
|-
| email method was removed || Implemented || N/A
|-
| Merged export and export_fields methods || Implemented || To be completed
|}

=== Replaced force_delete Method with leave_team Method ===
The original 'force_delete' method would delete the participant from the team and if there is only one participant in the team then it would delete the team.
[[File:E2317_force_delete.jpg | 800px]]

A new method 'leave_team' was introduced in place of 'force_delete' as 'force_delete' method is supposed to be present in the teams.rb and not participant.rb. The difference between force_delete method and this is that even if there is only one participant it wouldn't delete the team.

[[File:E2317_leave_team.jpg | 800px]]

=== mail_assigned_reviewers Method was Removed ===
The method 'Mail_assigned_reviewers' is responsible for sending an email to the assigned reviewer whenever a new submission is made. It would be more appropriate for this method to be included in teams.rb rather than participant.rb. Hence, this method was removed.

=== able_to_review Method was Removed ===
'able_to_review' method is just using can_review value. This method can be eliminated.

=== email Method was Removed ===
'email' method was removed as it was not required.

=== Merged export and export_fields Methods ===
'export' and 'export_fields' methods can be merged to form a single method under 'export'.

Before merging:

[[File:E2317_export_exportfields.jpg | 800px]]

After merging:

[[File:E2317_merge.jpg | 800px]]

==Testing Plan==

The reimplementation codebase originally used Minitest to test the included models: assignment.rb, role.rb, and user.rb. But since Expertiza was originally tested with RSpec, we used RSpec to test out model. The participants.rb contains many methods and associations with other models. Hence, to test the methods in participants, the other dependent methods have to be stubbed. To deal with the models, dummy models/dummy app can be created which will act as the associated classes. We have created all the required dummy classes by scaffolding them.

To create test fixtures and to build the required models, Factory Bot has been used. Two separate files, factories.rb and factory_bot.rb was created to build the factories.

4 participants and other required fields were created as fixtures after which the tests were written.

====Note====

The dummy classes that were created and other dependencies that were specifically installed for testing have been pushed to a different branch to not let the main codebase clutter with empty models.

To run the tests, kindly pull from the [https://github.com/amarthyasa/reimplementation-back-end/tree/testing_files testing_files] branch of the repository and run bundle install to install dependencies like RSpec and Factory Bot.

====Tests====

Test 1: Tests if the team method returns the team of the participant.
 
Test 2: Tests if the leave_team method deletes a participant if no associations exist and force is nil.
 
Test 3: Tests if the leave_team method deletes a participant if no associations exist and force is true.
 
Test 4: Tests if the leave_team method deletes a participant with associations and force is true and there are multiple team users.
 
The test which checks if participant and team is deleted if only one participant is on a team is deleted since that implementation has been removed from the model.
 
Test 5: Tests if the name method returns the name of the participant.
 
Test 6: Tests if the fullname method returns the full name of the participant.
 
Test 7: Tests if the handle method returns the handle of the participant.
 
Test 8: Tests if the sor_by_name method returns a sorted list of participants in alphabetical order.
 
Test 9: Tests if the topic_name method returns the participant topic name when nil.
 
Test 10: Tests if the topic_name method returns the participant topic name when not nil.
 
Test 11: Tests if the authorization method returns participant when no arguments are passed.
 
Test 12: Tests if the authorization method returns reader when no arguments are passed.
 
Test 13: Tests if the authorization method returns submitter when no arguments are passed.
 
Test 14: Tests if the authorization method returns reviewer when no arguments are passed.

==Future Work==

1. Testing for the merged method, export, has to be done.

2. Response method has to be tested.

==Relevant Links==

Github repository: https://github.com/amarthyasa/reimplementation-back-end/tree/main
 
Github repository branch for testing: https://github.com/amarthyasa/reimplementation-back-end/tree/testing_files
 
Pull request: https://github.com/expertiza/reimplementation-back-end/pull/5
 
Testing video:

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-03-23T01:56:27Z

Kjayesh:

This wiki page is for the description of changes made under E2317 OSS assignment for Spring 2023, CSC/ECE 517

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. It is a web application which is maintained collectively by NC State faculty and students which allows instructors to create new assignments and customize new or existing assignments. It also allows the instructors 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.

==Overview of the Classes==
===participant.rb===
The participant.rb is a model class that has many associations with other models. There are many methods present in it such as fullname, name, team and handle. There is a method called delete which checks for any associations before performing the delete operation. The other methods include topic_name, mail_assigned_reviewers, able_to_review, email, authorization and self.sort_by_name. There is one more method self.export that returns the information of the participant as a CSV file.

==Backgroud of the Project==
The participant.rb model has many new changes to be implemented. The reimplementation has to make sense and while checking the original model, we realised that some of the methods were irrelevant to participants model and that it has to be implemented in some other model. The changes mainly dealt with removing, merging and replacing methods to segregate methods with a single functionality relevant to participants model. Tests were written for all of the methods that were introduced and modified. Existing tests for the methods that were unchanged were run to ensure proper functioning of the model. Comments are added to each method to enhance readability. Further information about the reimplementations are discussed below.

==Design Decisions==
The following changes were reimplemented in the participant.rb

{| class="wikitable" style="margin-left:40px"
|-
! Tasks !! Status !! Testing
|-
| Replaced force_delete method with leave_team method
|| Implemented || Completed
|-
| mail_assigned_reviewers method was removed || Implemented || N/A
|-
| able_to_review method was eliminated || Implemented || N/A
|-
| email method was removed || Implemented || N/A
|-
| Merged export and export_fields methods || Implemented || To be completed
|}

=== Replaced force_delete Method with leave_team Method ===
The original 'force_delete' method would delete the participant from the team and if there is only one participant in the team then it would delete the team.
[[File:E2317_force_delete.jpg | 800px]]

A new method 'leave_team' was introduced in place of 'force_delete' as 'force_delete' method is supposed to be present in the teams.rb and not participant.rb. The difference between force_delete method and this is that even if there is only one participant it wouldn't delete the team.

[[File:E2317_leave_team.jpg | 800px]]

=== mail_assigned_reviewers Method was Removed ===
The method 'Mail_assigned_reviewers' is responsible for sending an email to the assigned reviewer whenever a new submission is made. It would be more appropriate for this method to be included in teams.rb rather than participant.rb. Hence, this method was removed.

=== able_to_review Method was Removed ===
'able_to_review' method is just using can_review value. This method can be eliminated.

=== email Method was Removed ===
'email' method was removed as it was not required.

=== Merged export and export_fields Methods ===
'export' and 'export_fields' methods can be merged to form a single method under 'export'.

Before merging:

[[File:E2317_export_exportfields.jpg | 800px]]

After merging:

[[File:E2317_merge.jpg | 800px]]

==Testing Plan==

The reimplementation codebase originally used Minitest to test the included models: assignment.rb, role.rb, and user.rb. But since Expertiza was originally tested with RSpec, we used RSpec to test out model. The participants.rb contains many methods and associations with other models. Hence, to test the methods in participants, the other dependent methods have to be stubbed. To deal with the models, dummy models/dummy app can be created which will act as the associated classes. We have created all the required dummy classes by scaffolding them.

To create test fixtures and to build the required models, Factory Bot has been used. Two separate files, factories.rb and factory_bot.rb was created to build the factories.

4 participants and other required fields were created as fixtures after which the tests were written.

====Note====

The dummy classes that were created and other dependencies that were specifically installed for testing have been pushed to a different branch to not let the main codebase clutter with empty models.

To run the tests, kindly pull from the [https://github.com/amarthyasa/reimplementation-back-end/tree/testing_files testing_files] branch of the repository and run bundle install to install dependencies like RSpec and Factory Bot.

====Tests====

Test 1: Tests if the team method returns the team of the participant.
 
Test 2: Tests if the leave_team method deletes a participant if no associations exist and force is nil.
 
Test 3: Tests if the leave_team method deletes a participant if no associations exist and force is true.
 
Test 4: Tests if the leave_team method deletes a participant with associations and force is true and there are multiple team users.
 
The test which checks if participant and team is deleted if only one participant is on a team is deleted since that implementation has been removed from the model.
 
Test 5: Tests if the name method returns the name of the participant.
 
Test 6: Tests if the fullname method returns the full name of the participant.
 
Test 7: Tests if the handle method returns the handle of the participant.
 
Test 8: Tests if the sor_by_name method returns a sorted list of participants in alphabetical order.
 
Test 9: Tests if the topic_name method returns the participant topic name when nil.
 
Test 10: Tests if the topic_name method returns the participant topic name when not nil.
 
Test 11: Tests if the authorization method returns participant when no arguments are passed.
 
Test 12: Tests if the authorization method returns reader when no arguments are passed.
 
Test 13: Tests if the authorization method returns submitter when no arguments are passed.
 
Test 14: Tests if the authorization method returns reviewer when no arguments are passed.

==Future Work==

1. Testing for the merged method, export, has to be done.

2. Response method has to be tested.

==Relevant Links==

Github Repository: https://github.com/amarthyasa/reimplementation-back-end/tree/main

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-03-23T01:54:50Z

Kjayesh: /* Tests */

This wiki page is for the description of changes made under E2317 OSS assignment for Spring 2023, CSC/ECE 517

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. It is a web application which is maintained collectively by NC State faculty and students which allows instructors to create new assignments and customize new or existing assignments. It also allows the instructors 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.

==Overview of the Classes==
===participant.rb===
The participant.rb is a model class that has many associations with other models. There are many methods present in it such as fullname, name, team and handle. There is a method called delete which checks for any associations before performing the delete operation. The other methods include topic_name, mail_assigned_reviewers, able_to_review, email, authorization and self.sort_by_name. There is one more method self.export that returns the information of the participant as a CSV file.

==Backgroud of the Project==
The participant.rb model has many new changes to be implemented. The reimplementation has to make sense and while checking the original model, we realised that some of the methods were irrelevant to participants model and that it has to be implemented in some other model. The changes mainly dealt with removing, merging and replacing methods to segregate methods with a single functionality relevant to participants model. Tests were written for all of the methods that were introduced and modified. Existing tests for the methods that were unchanged were run to ensure proper functioning of the model. Comments are added to each method to enhance readability. Further information about the reimplementations are discussed below.

==Design Decisions==
The following changes were reimplemented in the participant.rb

{| class="wikitable" style="margin-left:40px"
|-
! Tasks !! Status !! Testing
|-
| Replaced force_delete method with leave_team method
|| Implemented || Completed
|-
| mail_assigned_reviewers method was removed || Implemented || N/A
|-
| able_to_review method was eliminated || Implemented || N/A
|-
| email method was removed || Implemented || N/A
|-
| Merged export and export_fields methods || Implemented || To be completed
|}

=== Replaced force_delete Method with leave_team Method ===
The original 'force_delete' method would delete the participant from the team and if there is only one participant in the team then it would delete the team.
[[File:E2317_force_delete.jpg | 800px]]

A new method 'leave_team' was introduced in place of 'force_delete' as 'force_delete' method is supposed to be present in the teams.rb and not participant.rb. The difference between force_delete method and this is that even if there is only one participant it wouldn't delete the team.

[[File:E2317_leave_team.jpg | 800px]]

=== mail_assigned_reviewers Method was Removed ===
The method 'Mail_assigned_reviewers' is responsible for sending an email to the assigned reviewer whenever a new submission is made. It would be more appropriate for this method to be included in teams.rb rather than participant.rb. Hence, this method was removed.

=== able_to_review Method was Removed ===
'able_to_review' method is just using can_review value. This method can be eliminated.

=== email Method was Removed ===
'email' method was removed as it was not required.

=== Merged export and export_fields Methods ===
'export' and 'export_fields' methods can be merged to form a single method under 'export'.

Before merging:

[[File:E2317_export_exportfields.jpg | 800px]]

After merging:

[[File:E2317_merge.jpg | 800px]]

==Testing Plan==

The reimplementation codebase originally used Minitest to test the included models: assignment.rb, role.rb, and user.rb. But since Expertiza was originally tested with RSpec, we used RSpec to test out model. The participants.rb contains many methods and associations with other models. Hence, to test the methods in participants, the other dependent methods have to be stubbed. To deal with the models, dummy models/dummy app can be created which will act as the associated classes. We have created all the required dummy classes by scaffolding them.

To create test fixtures and to build the required models, Factory Bot has been used. Two separate files, factories.rb and factory_bot.rb was created to build the factories.

4 participants and other required fields were created as fixtures after which the tests were written.

====Note====

The dummy classes that were created and other dependencies that were specifically installed for testing have been pushed to a different branch to not let the main codebase clutter with empty models.

To run the tests, kindly pull from the [https://github.com/amarthyasa/reimplementation-back-end/tree/testing_files testing_files] branch of the repository and run bundle install to install dependencies like RSpec and Factory Bot.

====Tests====

Test 1: Tests if the team method returns the team of the participant.
 
Test 2: Tests if the leave_team method deletes a participant if no associations exist and force is nil.
 
Test 3: Tests if the leave_team method deletes a participant if no associations exist and force is true.
 
Test 4: Tests if the leave_team method deletes a participant with associations and force is true and there are multiple team users.
 
The test which checks if participant and team is deleted if only one participant is on a team is deleted since that implementation has been removed from the model.
 
Test 5: Tests if the name method returns the name of the participant.
 
Test 6: Tests if the fullname method returns the full name of the participant.
 
Test 7: Tests if the handle method returns the handle of the participant.
 
Test 8: Tests if the sor_by_name method returns a sorted list of participants in alphabetical order.
 
Test 9: Tests if the topic_name method returns the participant topic name when nil.
 
Test 10: Tests if the topic_name method returns the participant topic name when not nil.
 
Test 11: Tests if the authorization method returns participant when no arguments are passed.
 
Test 12: Tests if the authorization method returns reader when no arguments are passed.
 
Test 13: Tests if the authorization method returns submitter when no arguments are passed.
 
Test 14: Tests if the authorization method returns reviewer when no arguments are passed.

==Future Work==

1. Testing for the merged method, export, has to be done.

2. Response method has to be tested.

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-03-23T01:51:36Z

Kjayesh:

This wiki page is for the description of changes made under E2317 OSS assignment for Spring 2023, CSC/ECE 517

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. It is a web application which is maintained collectively by NC State faculty and students which allows instructors to create new assignments and customize new or existing assignments. It also allows the instructors 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.

==Overview of the Classes==
===participant.rb===
The participant.rb is a model class that has many associations with other models. There are many methods present in it such as fullname, name, team and handle. There is a method called delete which checks for any associations before performing the delete operation. The other methods include topic_name, mail_assigned_reviewers, able_to_review, email, authorization and self.sort_by_name. There is one more method self.export that returns the information of the participant as a CSV file.

==Backgroud of the Project==
The participant.rb model has many new changes to be implemented. The reimplementation has to make sense and while checking the original model, we realised that some of the methods were irrelevant to participants model and that it has to be implemented in some other model. The changes mainly dealt with removing, merging and replacing methods to segregate methods with a single functionality relevant to participants model. Tests were written for all of the methods that were introduced and modified. Existing tests for the methods that were unchanged were run to ensure proper functioning of the model. Comments are added to each method to enhance readability. Further information about the reimplementations are discussed below.

==Design Decisions==
The following changes were reimplemented in the participant.rb

{| class="wikitable" style="margin-left:40px"
|-
! Tasks !! Status !! Testing
|-
| Replaced force_delete method with leave_team method
|| Implemented || Completed
|-
| mail_assigned_reviewers method was removed || Implemented || N/A
|-
| able_to_review method was eliminated || Implemented || N/A
|-
| email method was removed || Implemented || N/A
|-
| Merged export and export_fields methods || Implemented || To be completed
|}

=== Replaced force_delete Method with leave_team Method ===
The original 'force_delete' method would delete the participant from the team and if there is only one participant in the team then it would delete the team.
[[File:E2317_force_delete.jpg | 800px]]

A new method 'leave_team' was introduced in place of 'force_delete' as 'force_delete' method is supposed to be present in the teams.rb and not participant.rb. The difference between force_delete method and this is that even if there is only one participant it wouldn't delete the team.

[[File:E2317_leave_team.jpg | 800px]]

=== mail_assigned_reviewers Method was Removed ===
The method 'Mail_assigned_reviewers' is responsible for sending an email to the assigned reviewer whenever a new submission is made. It would be more appropriate for this method to be included in teams.rb rather than participant.rb. Hence, this method was removed.

=== able_to_review Method was Removed ===
'able_to_review' method is just using can_review value. This method can be eliminated.

=== email Method was Removed ===
'email' method was removed as it was not required.

=== Merged export and export_fields Methods ===
'export' and 'export_fields' methods can be merged to form a single method under 'export'.

Before merging:

[[File:E2317_export_exportfields.jpg | 800px]]

After merging:

[[File:E2317_merge.jpg | 800px]]

==Testing Plan==

The reimplementation codebase originally used Minitest to test the included models: assignment.rb, role.rb, and user.rb. But since Expertiza was originally tested with RSpec, we used RSpec to test out model. The participants.rb contains many methods and associations with other models. Hence, to test the methods in participants, the other dependent methods have to be stubbed. To deal with the models, dummy models/dummy app can be created which will act as the associated classes. We have created all the required dummy classes by scaffolding them.

To create test fixtures and to build the required models, Factory Bot has been used. Two separate files, factories.rb and factory_bot.rb was created to build the factories.

4 participants and other required fields were created as fixtures after which the tests were written.

====Note====

The dummy classes that were created and other dependencies that were specifically installed for testing have been pushed to a different branch to not let the main codebase clutter with empty models.

To run the tests, kindly pull from the [https://github.com/amarthyasa/reimplementation-back-end/tree/testing_files testing_files] branch of the repository and run bundle install to install dependencies like RSpec and Factory Bot.

====Tests====

Test 1: Tests if the team method returns the team of the participant.

Test 2: Tests if the leave_team method deletes a participant if no associations exist and force is nil.

Test 3: Tests if the leave_team method deletes a participant if no associations exist and force is true.

Test 4: Tests if the leave_team method deletes a participant with associations and force is true and there are multiple team users.

The test which checks if participant and team is deleted if only one participant is on a team is deleted since that implementation has been removed from the model.

Test 5: Tests if the name method returns the name of the participant.

Test 6: Tests if the fullname method returns the full name of the participant.

Test 7: Tests if the handle method returns the handle of the participant.

Test 8: Tests if the sor_by_name method returns a sorted list of participants in alphabetical order.

Test 9: Tests if the topic_name method returns the participant topic name when nil.

Test 10: Tests if the topic_name method returns the participant topic name when not nil.

Test 11: Tests if the authorization method returns participant when no arguments are passed.

Test 12: Tests if the authorization method returns reader when no arguments are passed.

Test 13: Tests if the authorization method returns submitter when no arguments are passed.

Test 14: Tests if the authorization method returns reviewer when no arguments are passed.

==Future Work==

1. Testing for the merged method, export, has to be done.

2. Response method has to be tested.

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-03-23T01:45:18Z

Kjayesh: /* Tests */

This wiki page is for the description of changes made under E2317 OSS assignment for Spring 2023, CSC/ECE 517

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. It is a web application which is maintained collectively by NC State faculty and students which allows instructors to create new assignments and customize new or existing assignments. It also allows the instructors 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.

==Overview of the Classes==
===participant.rb===
The participant.rb is a model class that has many associations with other models. There are many methods present in it such as fullname, name, team and handle. There is a method called delete which checks for any associations before performing the delete operation. The other methods include topic_name, mail_assigned_reviewers, able_to_review, email, authorization and self.sort_by_name. There is one more method self.export that returns the information of the participant as a CSV file.

==Backgroud of the Project==
The participant.rb model has many new changes to be implemented. The reimplementation has to make sense and while checking the original model, we realised that some of the methods were irrelevant to participants model and that it has to be implemented in some other model. The changes mainly dealt with removing, merging and replacing methods to segregate methods with a single functionality relevant to participants model. Tests were written for all of the methods that were introduced and modified. Existing tests for the methods that were unchanged were run to ensure proper functioning of the model. Comments are added to each method to enhance readability. Further information about the reimplementations are discussed below.

==Design Decisions==
The following changes were reimplemented in the participant.rb

{| class="wikitable" style="margin-left:40px"
|-
! Tasks !! Status !! Testing
|-
| Replaced force_delete method with leave_team method
|| Implemented || Completed
|-
| mail_assigned_reviewers method was removed || Implemented || N/A
|-
| able_to_review method was eliminated || Implemented || N/A
|-
| email method was removed || Implemented || N/A
|-
| Merged export and export_fields methods || Implemented || To be completed
|}

=== Replaced force_delete Method with leave_team Method ===
The original 'force_delete' method would delete the participant from the team and if there is only one participant in the team then it would delete the team.
[[File:E2317_force_delete.jpg | 800px]]

A new method 'leave_team' was introduced in place of 'force_delete' as 'force_delete' method is supposed to be present in the teams.rb and not participant.rb. The difference between force_delete method and this is that even if there is only one participant it wouldn't delete the team.

[[File:E2317_leave_team.jpg | 800px]]

=== mail_assigned_reviewers Method was Removed ===
The method 'Mail_assigned_reviewers' is responsible for sending an email to the assigned reviewer whenever a new submission is made. It would be more appropriate for this method to be included in teams.rb rather than participant.rb. Hence, this method was removed.

=== able_to_review Method was Removed ===
'able_to_review' method is just using can_review value. This method can be eliminated.

=== email Method was Removed ===
'email' method was removed as it was not required.

=== Merged export and export_fields Methods ===
'export' and 'export_fields' methods can be merged to form a single method under 'export'.

Before merging:

[[File:E2317_export_exportfields.jpg | 800px]]

After merging:

[[File:E2317_merge.jpg | 800px]]

==Testing Plan==

The reimplementation codebase originally used Minitest to test the included models: assignment.rb, role.rb, and user.rb. But since Expertiza was originally tested with RSpec, we used RSpec to test out model. The participants.rb contains many methods and associations with other models. Hence, to test the methods in participants, the other dependent methods have to be stubbed. To deal with the models, dummy models/dummy app can be created which will act as the associated classes. We have created all the required dummy classes by scaffolding them.

To create test fixtures and to build the required models, Factory Bot has been used. Two separate files, factories.rb and factory_bot.rb was created to build the factories.

4 participants and other required fields were created as fixtures after which the tests were written.

====Note====

The dummy classes that were created and other dependencies that were specifically installed for testing have been pushed to a different branch to not let the main codebase clutter with empty models.

To run the tests, kindly pull from the [https://github.com/amarthyasa/reimplementation-back-end/tree/testing_files testing_files] branch of the repository and run bundle install to install dependencies like RSpec and Factory Bot.

====Tests====

Test 1: Tests if the team method returns the team of the participant.

Test 2: Tests if the leave_team method deletes a participant if no associations exist and force is nil.

Test 3: Tests if the leave_team method deletes a participant if no associations exist and force is true.

Test 4: Tests if the leave_team method deletes a participant with associations and force is true and there are multiple team users.

The test which checks if participant and team is deleted if only one participant is on a team is deleted since that implementation has been removed from the model.

Test 5: Tests if the name method returns the name of the participant.

Test 6: Tests if the fullname method returns the full name of the participant.

Test 7: Tests if the handle method returns the handle of the participant.

Test 8: Tests if the sor_by_name method returns a sorted list of participants in alphabetical order.

Test 9: Tests if the topic_name method returns the participant topic name when nil.

Test 10: Tests if the topic_name method returns the participant topic name when not nil.

Test 11: Tests if the authorization method returns participant when no arguments are passed.

Test 12: Tests if the authorization method returns reader when no arguments are passed.

Test 13: Tests if the authorization method returns submitter when no arguments are passed.

Test 14: Tests if the authorization method returns reviewer when no arguments are passed.

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-03-23T01:42:58Z

Kjayesh: /* Testing Plan */

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-03-23T01:42:31Z

Kjayesh: /* Tests */

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-03-23T01:37:37Z

Kjayesh: /* Testing Plan */

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-03-23T01:26:12Z

Kjayesh: /* Testing Plan */

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-03-23T01:25:52Z

Kjayesh: /* Testing Plan */

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-03-23T01:20:06Z

Kjayesh: /* Testing Plan */

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-03-23T01:18:14Z

Kjayesh: /* Testing Plan */

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-03-23T01:15:41Z

Kjayesh: /* Testing Plan */

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-03-23T01:09:30Z

Kjayesh: /* Testing Plan */

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-03-23T00:49:03Z

Kjayesh: /* Testing Plan */

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-03-22T23:44:59Z

Kjayesh: /* Tasks Identified */

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-03-22T23:42:20Z

Kjayesh: /* Backgroud of the Project */

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-03-22T23:30:49Z

Kjayesh: /* Replaced force_delete Method with leave_team Method */

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-03-22T23:27:32Z

Kjayesh: /* Overview of the Classes */

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-03-22T23:27:16Z

Kjayesh: /* About Expertiza */

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-03-22T23:26:33Z

Kjayesh: /* Introduction */

This wiki page is for the description of changes made under E2317 OSS assignment for Spring 2023, CSC/ECE 517

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. It is a web application which is maintained collectively by NC State faculty and students which allows instructors to create new assignments and customize new or existing assignments. It also allows the instructors 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.

===Overview of the Classes===
====participant.rb====
The participant.rb is a model class that has many associations with other models. There are many methods present in it such as fullname, name, team and handle. There is a method called delete which checks for any associations before performing the delete operation. The other methods include topic_name, mail_assigned_reviewers, able_to_review, email, authorization and self.sort_by_name. There is one more method self.export that returns the information of the participant as a CSV file.

===Backgroud of the Project===
The participant.rb has many new changes to be implemented. We have made modifications to the model in accordance with the changes that were suggested. The changes mainly dealt with removing, merging and replacing methods. Tests were written for functions that were introduced and modified. Existing tests were run to ensure proper functioning of the model. Comments were added to each function to enhance readability.

==Tasks Identified==
The following changes were reimplemented in the participant.rb

1. Replaced force_delete method with leave_team method.

2. mail_assigned_reviewers method was removed.

3. able_to_review method was eliminated.

4. email method was removed as it was not required.

5. Merged export and export_fields methods.

=== Replaced force_delete Method with leave_team Method ===
The original 'force_delete' method would delete the participant from the team and if there is only one participant in the team then it would delete the team.
[[File:E2317_force_delete.jpg | 800px]]

A new method 'leave_team'was introduced in place of 'force_delete' as 'force_delete' method is supposed to be present in the teams.rb and not participant.rb. The difference between force_delete method and this is that even if there is only one participant it wouldn't delete the team.

[[File:E2317_leave_team.jpg | 800px]]

==Testing Plan==