Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2025 - E2538 Reimplementing Questionnaire Page in Expertiza

2025-04-23T03:54:05Z

Mwander5: /* Reference Links */

==E2538 Reimplementing Questionnaire Page==

__TOC__

==About Expertiza==
Expertiza is an open-source web application currently built using [http://rubyonrails.org/ Ruby on Rails] and led by [https://www.csc.ncsu.edu/people/efg Dr. Edward Gehringer]. Designed for educational use, it enables instructors to manage assignments, rubrics, and participants, as well as assign grades and monitor student progress. Students can submit various types of learning objects, form teams, conduct peer evaluations, and review feedback from both peers and instructors. Originally developed at NC State, Expertiza is now used in select courses there and by faculty at other institutions, offering a flexible platform to enhance active learning and feedback in academic settings.

The reimplementation of Expertiza aims to mimic and enhance the application’s existing functionality with clean, well-structured code, while transitioning to a front-end application written in React and Typescipt integrated with a Ruby on Rails back-end.

==Project Overview==
The goal of this project is to implement the Questionnaire Management Dashboard and Create/Edit Rubric pages in Expertiza by reimplementing its frontend using React with TypeScript, while integrating it with the existing Ruby on Rails backend APIs in the reimplementation backend repo. The new implementation will improve user experience, maintainability, and scalability while preserving core functionalities.

This project covers:

* Developing a React-based UI for managing questionnaire rubrics.

* Enabling navigation to a new page when clicking the "+" button to create a specific rubric for a questionnaire type.

* Ensuring seamless API integration with the reimplementation backend repo.

* Managing user sessions and authentication securely.

While adhering to the following best practices:

*Component Reusability (DRY Principle): Design reusable and modular components to avoid duplication and simplify maintenance, adhering to the "Don't Repeat Yourself" principle.

*Separation of Concerns: Keep the UI, state management, and business logic separated. Use container components for state and logic and presentational components for rendering.

*Responsive and Accessible Design: Ensure the UI adapts to different devices and meets accessibility standards (e.g., ARIA roles, keyboard navigation, and proper contrast).

*Type Safety with TypeScript: Use TypeScript interfaces and types to ensure data consistency, reduce runtime errors.

*Single Responsibility Principle: Each component or function should have a single, well-defined purpose to improve clarity, testability, and scalability.

==What Needs to be Done?==
===Questionnaire Management Dashboard===

Displays a list of questionnaire types (Review, Metareview, Author Feedback, etc.)
* Each questionnaire type has a "+" button, which, when clicked, navigates to a new page for creating a specific rubric for that questionnaire type.
* Data is fetched dynamically from the backend.

[[File:Picx1x.png | 700px]]

===Create/Edit Rubric Page===

This page is displayed when a user clicks the "+" button from the dashboard.

Allows users to:
* Enter a name for the rubric.
* Define min/max item scores.
* Set the review visibility (private/public).
* Add criteria for evaluation.
* Submit the form to create a new rubric for the selected questionnaire type.

[[File:Picx2x.png | 700px]]

==Backend Integration==

The frontend interacts with several key resources exposed by the backend through a RESTful API. The structure of each model's associated database table lets us define Typescript interfaces, transform request/response payloads and promote type safety.

===Models===

====Questionnaire====

The <code>Questionnaire</code> model forms the foundation of the Create/Edit form functionality, storing necessary attributes for each questionnaire. These fields are used to construct a form for editing or creating a rubric and to prepopulate the form when editing an existing rubric.

The backend database also includes a table of <code>questionnaire_types</code>, access to which would allow the Questionnaire Management Dashboard to dynamically render all available categories of questionnaires and enable users to initiate the creation process based on a selected type.

{| class="wikitable"
! Attribute !! Description
|-
| id || Unique identifier for the questionnaire
|-
| name || The name/title of the questionnaire
|-
| instructor_id || Foreign key referencing the instructor who created it
|-
| private || Boolean indicating if the questionnaire is private
|-
| min_question_score || Minimum score that can be given to any question
|-
| max_question_score || Maximum score that can be given to any question
|-
| questionnaire_type || The type/category of questionnaire (e.g., Survey, Teammate Review)
|-
| display_type || Field for specifying how to display the questionnaire
|-
| instruction_loc || Field for custom instructions location or reference
|-
| created_at || Timestamp of questionnaire creation
|-
| updated_at || Timestamp of last update
|}

====Item====

The <code>Item</code> model represents individual items (or questions) within a questionnaire and includes attributes that should be included when adding an item to a particular questionnaire.

{| class="wikitable"
! Attribute !! Description
|-
| id || Unique identifier for the item
|-
| txt || The text of the item/question
|-
| weight || The relative importance or weight of the item
|-
| seq || The sequence/order of the item in the questionnaire
|-
| question_type || Foreign key referencing the type of question
|-
| size || Size attribute for text-based answers (e.g., text area size)
|-
| alternatives || Possible answer choices (comma-separated for multiple-choice)
|-
| break_before || Boolean indicating whether to insert a page break before the item
|-
| max_label || Optional label for the maximum scale value
|-
| min_label || Optional label for the minimum scale value
|-
| created_at || Timestamp of item creation
|-
| updated_at || Timestamp of last update
|-
| questionnaire_id || Foreign key referencing the associated questionnaire
|}

===API Endpoints===

To facilitate interaction with the backend, the frontend uses a pre-configured <code>axiosClient</code>, which abstracts the base API URL and port number. This client is defined in the <code>utils/axios_client.ts</code> file and reused throughout the project for API communication. For questionnaire management, several key API routes are accessed using this client. For example, <code>GET /questionnaires/:id</code> fetches detailed data for editing a selected questionnaire. When creating or updating a questionnaire, the application uses <code>POST /questionnaires</code> and <code>PUT /questionnaires/:id</code>, respectively.

{| class="wikitable"
|+
! HTTP Method !! Endpoint !! Description
|-
| GET || /questionnaires || Fetches a list of all questionnaires
|-
| GET || /questionnaires/:id || Fetches a specific questionnaire by ID
|-
| POST || /questionnaires || Creates a new questionnaire
|-
| PUT || /questionnaires/:id || Updates an existing questionnaire
|-
| DELETE || /questionnaires/:id || Deletes a specific questionnaire
|-
| GET || /questions || Retrieves a list of all questions (items)
|-
| GET || /questions/:id || Retrieves a specific item, along with its rendered display
|-
| POST || /questions || Creates a new item for a questionnaire
|-
| PUT || /questions/:id || Updates an existing item
|}

==Implementation==
===User Interface===

====Manage Questionnaires====

To navigate to the Questionnaire Management Dashboard, Questionnaire from the Manage dropdown from any page on Expertiza.

To be consistent with other management pages (for Users, Courses, Assignements) in the reimplementation front end, a table of questionnaires belonging to the logged-in instructor is visible on the page. From this page, you may create, edit, or delete a questionnaire.

To create a new questionnaire, click on the Create button in the top left corner of the page.

[[File:ManagementDashboard.png | 700px]]

====Type Selection====

When the Create button is selected from the top of the Questionnaire Management Dashboard, a pop-up appears with the available questionnaire types. To create a questionnaire of a given type, select the "+" botton in the row of the desired type.

[[File:TypeSelection.png | 700px]]

====Questionnaire Form====

Once a type has been selected, the user is directed to the appropriate form to create a questionnaire of the selected type. The user can include a variable number of items to the questionnaire at the time of creation. The required fields for an item is determined by the item type. For example, a scale type item required minimum and maximum values for its scale.

[[File:Questionnaire Form.png | 700px]]

Once a form field has been touched, the application alerts the user of missing required fields. Failure to provide appropriate values will prevent form submission.

[[File:Screenshot 2025-04-22 at 10.12.22 AM.png | 700px]]

Upon successful submission, the newly-created questionnaire will appear in the list of questionnaires in the Questionnaire Management Dashboard.

[[File:Editquestionnaireselect.png | 700px]]

To edit a questionnaire, select the edit icon next to the questionnaire you want to edit. You will be directed to a form with the existing questionnaire and items filled in.

[[File:Editquestionnaire.png | 700px]]

===QuestionnaireUtils.ts===
The <code>QuestionnaireUtils.ts</code> file serves as a utility module for handling questionnaire-related functionality in the application, including interfaces, data transformation methods, and back-end data retrieval. This file helps maintain clear separation of concerns, type safety, and adherence to design principles such as the Single Responsibility Principle (SRP).

===QuestionnaireForm.tsx===
The <code>QuestionnaireForm.tsx</code> file is a React component that provides a form interface for creating or editing questionnaires. It integrates with Formik for form state management and validation, utilizing React Bootstrap for UI elements.

The form fields are strongly typed using Formik's <code>Field</code> components and the <code>QuestionnaireFormValues</code> interface, ensuring that the data entered by the user adheres to the correct structure.
*Name: A text field for entering the questionnaire name.
*Type: A hidden input used to specify the type of the questionnaire selected from the Questionnaire Management Dashboard and to be passed to the back-end.
*Private: A checkbox to indicate whether the questionnaire is private.
*Minimum/Maximum Question Scores: Numeric fields for setting the minimum and maximum scores for questions.

The form delegates the responsibility of handling questionnaire items to the <code>QuestionnaireItemsFieldArray</code> component, which allows users to add or remove items dynamically and keeps each component focused on a single responsibility.

===QuestionnaireTypes.tsx===
This component renders a table that displays different types of questionnaires. Each row provides an action to navigate to the corresponding creation page for the selected questionnaire type. The <code>Table</code> component from <code>components/Table/Table</code> is used in adherence with the DRY Principle and the provided design guidelines.

==Code Changes Summary==
{| class="wikitable"
! File !! Method / Function !! Before !! After / Changes Introduced !! Commit Summary
|-
| App.tsx || Routing to /questionnaire and /edit-questionnaire || Not defined or incomplete || Added `ProtectedRoute` wrappers and proper routing to `Questionnaire` and `EditQuestionnaire` || Updated App.tsx
|-
| Questionnaire.tsx || render(), type grouping || Basic list display || Grouped by type, added "+" button for creating new rubrics || Update Questionnaire.tsx
|-
| Questionnaire.tsx || Add rubric handler || Not implemented || Clicking "+" navigates to `edit-questionnaire` with type parameter || More UI updates
|-
| EditQuestionnaire.tsx || Form handling & API integration || Static layout || Full integration with axios POST/PUT calls to backend || updated interface so it can now update backend
|-
| EditQuestionnaire.tsx || Questionnaire name editing || Not available || Name can now be edited from the UI || More functionality updates
|-
| EditQuestionnaire.tsx || Display and manage rubric items || Static list || Dynamically displays and adds rubric items || Properly displays items and properly adds items
|-
| questionnaire.tsx || Icons and UI elements || No icons || Edit, delete, and copy icons added for each row || More UI updates, including icons
|-
| axios_client.ts || axios client usage || Not standardized || Shared axiosClient used for API calls across all pages || Integrated across changes
|}

==Files Modified==
The following files were created or modified to implement the questionnaire dashboard and rubric management UI in React with TypeScript:

*<code>src/pages/Questionnaire/questionnaire.tsx</code> – Implements the Questionnaire Management Dashboard UI and groups questionnaires by type with "+" action buttons.
*<code>src/pages/EditQuestionnaire/Questionnaire.tsx</code> – Create/Edit Rubric page that handles full form logic and submission.
*<code>src/App.tsx</code> – Updated routing to include new paths: <code>/questionnaire</code> and <code>/edit-questionnaire</code>, protected via <code>ProtectedRoute</code>.
*<code>src/assets/icons/</code> – Added new UI icons for edit, delete, and copy actions in the questionnaire list.
*<code>src/utils/axios_client.ts</code> – Preconfigured <code>axios</code> instance used throughout the frontend for API interactions.
*<code>package.json</code> and <code>package-lock.json</code> – Updated dependencies for React Bootstrap, Formik, and icon support.

Note: The previously separate files like <code>QuestionnaireForm.tsx</code>, <code>QuestionnaireItemsFieldArray.tsx</code>, and <code>QuestionnaireUtils.tsx</code> were refactored and consolidated into <code>EditQuestionnaire/Questionnaire.tsx</code> for improved maintainability.

==Test Plan - Manual Testing Strategy==
====Login Credentials====
To login to the application, use the following credentials:
* username: instructor6
* password: password

====Questionnaire Dashboard Loading====
* Visit <code>/questionnaire</code> and confirm that all types of questionnaires are displayed.
* "+" button next to each type should open the rubric creation form with the correct type preselected.

====Form Functionality====
* Enter name, min/max scores, and toggle the private/public checkbox.
* Dynamically add or remove criteria.
* Submit the form to create a new rubric and confirm it reflects on the dashboard.

====Edit Rubric====
* Click on an existing rubric's "Edit" icon to load it in the edit form.
* Modify any field (name, score range, criteria) and resubmit.
* Confirm updated rubric details persist and are displayed correctly.

====Form Validation====
* Leave required fields empty and confirm that validation messages are displayed.
* Enter invalid values (e.g., <code>max_score < min_score</code>) and confirm appropriate warnings are shown.

====API Communication====
* Verify that form submissions trigger <code>POST /questionnaires</code> or <code>PUT /questionnaires/:id</code>.
* Confirm that response handling updates the UI appropriately (e.g., rerenders list on successful save).

====UI Testing====
* Confirm that the layout is responsive across desktop, tablet, and mobile devices.
* Ensure accessibility: keyboard navigation works, form fields are properly labeled, and ARIA roles are used where needed.

==Team==
=====Mentor=====
*Prathyusha Kodali - pkodali

=====Members=====
*Ashwin Muniswamy - akumarm
*Michael Anderson - mwander5
*Martina Viola - mmviola

==Reference Links==
*[https://expertiza.ncsu.edu/tree_display/list?currCtlr=Questionnaires Questionnaire Management Dashboard]
*[https://expertiza.ncsu.edu/questionnaires/new?model=ReviewQuestionnaire&private=1 Create/Edit Rubric Page]
*[https://github.com/mmviola1/reimplementation-front-end-E2538 Project Repo]
*[http://152.7.176.255:8080 VCL Deployment]
*[https://github.com/expertiza/reimplementation-front-end/pull/94 Pull Request]

=====Demo Video=====
*[https://youtu.be/eVViM9_Gg80, Demo Video]

CSC/ECE 517 Spring 2025 - E2538 Reimplementing Questionnaire Page in Expertiza

2025-04-23T03:53:27Z

Mwander5: /* Reference Links */

==E2538 Reimplementing Questionnaire Page==

__TOC__

==About Expertiza==
Expertiza is an open-source web application currently built using [http://rubyonrails.org/ Ruby on Rails] and led by [https://www.csc.ncsu.edu/people/efg Dr. Edward Gehringer]. Designed for educational use, it enables instructors to manage assignments, rubrics, and participants, as well as assign grades and monitor student progress. Students can submit various types of learning objects, form teams, conduct peer evaluations, and review feedback from both peers and instructors. Originally developed at NC State, Expertiza is now used in select courses there and by faculty at other institutions, offering a flexible platform to enhance active learning and feedback in academic settings.

The reimplementation of Expertiza aims to mimic and enhance the application’s existing functionality with clean, well-structured code, while transitioning to a front-end application written in React and Typescipt integrated with a Ruby on Rails back-end.

==Project Overview==
The goal of this project is to implement the Questionnaire Management Dashboard and Create/Edit Rubric pages in Expertiza by reimplementing its frontend using React with TypeScript, while integrating it with the existing Ruby on Rails backend APIs in the reimplementation backend repo. The new implementation will improve user experience, maintainability, and scalability while preserving core functionalities.

This project covers:

* Developing a React-based UI for managing questionnaire rubrics.

* Enabling navigation to a new page when clicking the "+" button to create a specific rubric for a questionnaire type.

* Ensuring seamless API integration with the reimplementation backend repo.

* Managing user sessions and authentication securely.

While adhering to the following best practices:

*Component Reusability (DRY Principle): Design reusable and modular components to avoid duplication and simplify maintenance, adhering to the "Don't Repeat Yourself" principle.

*Separation of Concerns: Keep the UI, state management, and business logic separated. Use container components for state and logic and presentational components for rendering.

*Responsive and Accessible Design: Ensure the UI adapts to different devices and meets accessibility standards (e.g., ARIA roles, keyboard navigation, and proper contrast).

*Type Safety with TypeScript: Use TypeScript interfaces and types to ensure data consistency, reduce runtime errors.

*Single Responsibility Principle: Each component or function should have a single, well-defined purpose to improve clarity, testability, and scalability.

==What Needs to be Done?==
===Questionnaire Management Dashboard===

Displays a list of questionnaire types (Review, Metareview, Author Feedback, etc.)
* Each questionnaire type has a "+" button, which, when clicked, navigates to a new page for creating a specific rubric for that questionnaire type.
* Data is fetched dynamically from the backend.

[[File:Picx1x.png | 700px]]

===Create/Edit Rubric Page===

This page is displayed when a user clicks the "+" button from the dashboard.

Allows users to:
* Enter a name for the rubric.
* Define min/max item scores.
* Set the review visibility (private/public).
* Add criteria for evaluation.
* Submit the form to create a new rubric for the selected questionnaire type.

[[File:Picx2x.png | 700px]]

==Backend Integration==

The frontend interacts with several key resources exposed by the backend through a RESTful API. The structure of each model's associated database table lets us define Typescript interfaces, transform request/response payloads and promote type safety.

===Models===

====Questionnaire====

The <code>Questionnaire</code> model forms the foundation of the Create/Edit form functionality, storing necessary attributes for each questionnaire. These fields are used to construct a form for editing or creating a rubric and to prepopulate the form when editing an existing rubric.

The backend database also includes a table of <code>questionnaire_types</code>, access to which would allow the Questionnaire Management Dashboard to dynamically render all available categories of questionnaires and enable users to initiate the creation process based on a selected type.

{| class="wikitable"
! Attribute !! Description
|-
| id || Unique identifier for the questionnaire
|-
| name || The name/title of the questionnaire
|-
| instructor_id || Foreign key referencing the instructor who created it
|-
| private || Boolean indicating if the questionnaire is private
|-
| min_question_score || Minimum score that can be given to any question
|-
| max_question_score || Maximum score that can be given to any question
|-
| questionnaire_type || The type/category of questionnaire (e.g., Survey, Teammate Review)
|-
| display_type || Field for specifying how to display the questionnaire
|-
| instruction_loc || Field for custom instructions location or reference
|-
| created_at || Timestamp of questionnaire creation
|-
| updated_at || Timestamp of last update
|}

====Item====

The <code>Item</code> model represents individual items (or questions) within a questionnaire and includes attributes that should be included when adding an item to a particular questionnaire.

{| class="wikitable"
! Attribute !! Description
|-
| id || Unique identifier for the item
|-
| txt || The text of the item/question
|-
| weight || The relative importance or weight of the item
|-
| seq || The sequence/order of the item in the questionnaire
|-
| question_type || Foreign key referencing the type of question
|-
| size || Size attribute for text-based answers (e.g., text area size)
|-
| alternatives || Possible answer choices (comma-separated for multiple-choice)
|-
| break_before || Boolean indicating whether to insert a page break before the item
|-
| max_label || Optional label for the maximum scale value
|-
| min_label || Optional label for the minimum scale value
|-
| created_at || Timestamp of item creation
|-
| updated_at || Timestamp of last update
|-
| questionnaire_id || Foreign key referencing the associated questionnaire
|}

===API Endpoints===

To facilitate interaction with the backend, the frontend uses a pre-configured <code>axiosClient</code>, which abstracts the base API URL and port number. This client is defined in the <code>utils/axios_client.ts</code> file and reused throughout the project for API communication. For questionnaire management, several key API routes are accessed using this client. For example, <code>GET /questionnaires/:id</code> fetches detailed data for editing a selected questionnaire. When creating or updating a questionnaire, the application uses <code>POST /questionnaires</code> and <code>PUT /questionnaires/:id</code>, respectively.

{| class="wikitable"
|+
! HTTP Method !! Endpoint !! Description
|-
| GET || /questionnaires || Fetches a list of all questionnaires
|-
| GET || /questionnaires/:id || Fetches a specific questionnaire by ID
|-
| POST || /questionnaires || Creates a new questionnaire
|-
| PUT || /questionnaires/:id || Updates an existing questionnaire
|-
| DELETE || /questionnaires/:id || Deletes a specific questionnaire
|-
| GET || /questions || Retrieves a list of all questions (items)
|-
| GET || /questions/:id || Retrieves a specific item, along with its rendered display
|-
| POST || /questions || Creates a new item for a questionnaire
|-
| PUT || /questions/:id || Updates an existing item
|}

==Implementation==
===User Interface===

====Manage Questionnaires====

To navigate to the Questionnaire Management Dashboard, Questionnaire from the Manage dropdown from any page on Expertiza.

To be consistent with other management pages (for Users, Courses, Assignements) in the reimplementation front end, a table of questionnaires belonging to the logged-in instructor is visible on the page. From this page, you may create, edit, or delete a questionnaire.

To create a new questionnaire, click on the Create button in the top left corner of the page.

[[File:ManagementDashboard.png | 700px]]

====Type Selection====

When the Create button is selected from the top of the Questionnaire Management Dashboard, a pop-up appears with the available questionnaire types. To create a questionnaire of a given type, select the "+" botton in the row of the desired type.

[[File:TypeSelection.png | 700px]]

====Questionnaire Form====

Once a type has been selected, the user is directed to the appropriate form to create a questionnaire of the selected type. The user can include a variable number of items to the questionnaire at the time of creation. The required fields for an item is determined by the item type. For example, a scale type item required minimum and maximum values for its scale.

[[File:Questionnaire Form.png | 700px]]

Once a form field has been touched, the application alerts the user of missing required fields. Failure to provide appropriate values will prevent form submission.

[[File:Screenshot 2025-04-22 at 10.12.22 AM.png | 700px]]

Upon successful submission, the newly-created questionnaire will appear in the list of questionnaires in the Questionnaire Management Dashboard.

[[File:Editquestionnaireselect.png | 700px]]

To edit a questionnaire, select the edit icon next to the questionnaire you want to edit. You will be directed to a form with the existing questionnaire and items filled in.

[[File:Editquestionnaire.png | 700px]]

===QuestionnaireUtils.ts===
The <code>QuestionnaireUtils.ts</code> file serves as a utility module for handling questionnaire-related functionality in the application, including interfaces, data transformation methods, and back-end data retrieval. This file helps maintain clear separation of concerns, type safety, and adherence to design principles such as the Single Responsibility Principle (SRP).

===QuestionnaireForm.tsx===
The <code>QuestionnaireForm.tsx</code> file is a React component that provides a form interface for creating or editing questionnaires. It integrates with Formik for form state management and validation, utilizing React Bootstrap for UI elements.

The form fields are strongly typed using Formik's <code>Field</code> components and the <code>QuestionnaireFormValues</code> interface, ensuring that the data entered by the user adheres to the correct structure.
*Name: A text field for entering the questionnaire name.
*Type: A hidden input used to specify the type of the questionnaire selected from the Questionnaire Management Dashboard and to be passed to the back-end.
*Private: A checkbox to indicate whether the questionnaire is private.
*Minimum/Maximum Question Scores: Numeric fields for setting the minimum and maximum scores for questions.

The form delegates the responsibility of handling questionnaire items to the <code>QuestionnaireItemsFieldArray</code> component, which allows users to add or remove items dynamically and keeps each component focused on a single responsibility.

===QuestionnaireTypes.tsx===
This component renders a table that displays different types of questionnaires. Each row provides an action to navigate to the corresponding creation page for the selected questionnaire type. The <code>Table</code> component from <code>components/Table/Table</code> is used in adherence with the DRY Principle and the provided design guidelines.

==Code Changes Summary==
{| class="wikitable"
! File !! Method / Function !! Before !! After / Changes Introduced !! Commit Summary
|-
| App.tsx || Routing to /questionnaire and /edit-questionnaire || Not defined or incomplete || Added `ProtectedRoute` wrappers and proper routing to `Questionnaire` and `EditQuestionnaire` || Updated App.tsx
|-
| Questionnaire.tsx || render(), type grouping || Basic list display || Grouped by type, added "+" button for creating new rubrics || Update Questionnaire.tsx
|-
| Questionnaire.tsx || Add rubric handler || Not implemented || Clicking "+" navigates to `edit-questionnaire` with type parameter || More UI updates
|-
| EditQuestionnaire.tsx || Form handling & API integration || Static layout || Full integration with axios POST/PUT calls to backend || updated interface so it can now update backend
|-
| EditQuestionnaire.tsx || Questionnaire name editing || Not available || Name can now be edited from the UI || More functionality updates
|-
| EditQuestionnaire.tsx || Display and manage rubric items || Static list || Dynamically displays and adds rubric items || Properly displays items and properly adds items
|-
| questionnaire.tsx || Icons and UI elements || No icons || Edit, delete, and copy icons added for each row || More UI updates, including icons
|-
| axios_client.ts || axios client usage || Not standardized || Shared axiosClient used for API calls across all pages || Integrated across changes
|}

==Files Modified==
The following files were created or modified to implement the questionnaire dashboard and rubric management UI in React with TypeScript:

*<code>src/pages/Questionnaire/questionnaire.tsx</code> – Implements the Questionnaire Management Dashboard UI and groups questionnaires by type with "+" action buttons.
*<code>src/pages/EditQuestionnaire/Questionnaire.tsx</code> – Create/Edit Rubric page that handles full form logic and submission.
*<code>src/App.tsx</code> – Updated routing to include new paths: <code>/questionnaire</code> and <code>/edit-questionnaire</code>, protected via <code>ProtectedRoute</code>.
*<code>src/assets/icons/</code> – Added new UI icons for edit, delete, and copy actions in the questionnaire list.
*<code>src/utils/axios_client.ts</code> – Preconfigured <code>axios</code> instance used throughout the frontend for API interactions.
*<code>package.json</code> and <code>package-lock.json</code> – Updated dependencies for React Bootstrap, Formik, and icon support.

Note: The previously separate files like <code>QuestionnaireForm.tsx</code>, <code>QuestionnaireItemsFieldArray.tsx</code>, and <code>QuestionnaireUtils.tsx</code> were refactored and consolidated into <code>EditQuestionnaire/Questionnaire.tsx</code> for improved maintainability.

==Test Plan - Manual Testing Strategy==
====Login Credentials====
To login to the application, use the following credentials:
* username: instructor6
* password: password

====Questionnaire Dashboard Loading====
* Visit <code>/questionnaire</code> and confirm that all types of questionnaires are displayed.
* "+" button next to each type should open the rubric creation form with the correct type preselected.

====Form Functionality====
* Enter name, min/max scores, and toggle the private/public checkbox.
* Dynamically add or remove criteria.
* Submit the form to create a new rubric and confirm it reflects on the dashboard.

====Edit Rubric====
* Click on an existing rubric's "Edit" icon to load it in the edit form.
* Modify any field (name, score range, criteria) and resubmit.
* Confirm updated rubric details persist and are displayed correctly.

====Form Validation====
* Leave required fields empty and confirm that validation messages are displayed.
* Enter invalid values (e.g., <code>max_score < min_score</code>) and confirm appropriate warnings are shown.

====API Communication====
* Verify that form submissions trigger <code>POST /questionnaires</code> or <code>PUT /questionnaires/:id</code>.
* Confirm that response handling updates the UI appropriately (e.g., rerenders list on successful save).

====UI Testing====
* Confirm that the layout is responsive across desktop, tablet, and mobile devices.
* Ensure accessibility: keyboard navigation works, form fields are properly labeled, and ARIA roles are used where needed.

==Team==
=====Mentor=====
*Prathyusha Kodali - pkodali

=====Members=====
*Ashwin Muniswamy - akumarm
*Michael Anderson - mwander5
*Martina Viola - mmviola

==Reference Links==
*[https://expertiza.ncsu.edu/tree_display/list?currCtlr=Questionnaires Questionnaire Management Dashboard]
*[https://expertiza.ncsu.edu/questionnaires/new?model=ReviewQuestionnaire&private=1 Create/Edit Rubric Page]
*[https://github.com/Michael-Anderson-NCSU/reimplementation-front-end Project Repo]
*[http://152.7.176.255:8080 VCL Deployment]
*[https://github.com/expertiza/reimplementation-front-end/pull/94 Pull Request]

=====Demo Video=====
*[https://youtu.be/eVViM9_Gg80, Demo Video]

CSC/ECE 517 Spring 2025 - E2538 Reimplementing Questionnaire Page in Expertiza

2025-04-22T22:10:47Z

Mwander5: /* Reference Links */

==E2538 Reimplementing Questionnaire Page==

__TOC__

==About Expertiza==
Expertiza is an open-source web application currently built using [http://rubyonrails.org/ Ruby on Rails] and led by [https://www.csc.ncsu.edu/people/efg Dr. Edward Gehringer]. Designed for educational use, it enables instructors to manage assignments, rubrics, and participants, as well as assign grades and monitor student progress. Students can submit various types of learning objects, form teams, conduct peer evaluations, and review feedback from both peers and instructors. Originally developed at NC State, Expertiza is now used in select courses there and by faculty at other institutions, offering a flexible platform to enhance active learning and feedback in academic settings.

The reimplementation of Expertiza aims to mimic and enhance the application’s existing functionality with clean, well-structured code, while transitioning to a front-end application written in React and Typescipt integrated with a Ruby on Rails back-end.

==Project Overview==
The goal of this project is to implement the Questionnaire Management Dashboard and Create/Edit Rubric pages in Expertiza by reimplementing its frontend using React with TypeScript, while integrating it with the existing Ruby on Rails backend APIs in the reimplementation backend repo. The new implementation will improve user experience, maintainability, and scalability while preserving core functionalities.

This project covers:

* Developing a React-based UI for managing questionnaire rubrics.

* Enabling navigation to a new page when clicking the "+" button to create a specific rubric for a questionnaire type.

* Ensuring seamless API integration with the reimplementation backend repo.

* Managing user sessions and authentication securely.

While adhering to the following best practices:

*Component Reusability (DRY Principle): Design reusable and modular components to avoid duplication and simplify maintenance, adhering to the "Don't Repeat Yourself" principle.

*Separation of Concerns: Keep the UI, state management, and business logic separated. Use container components for state and logic and presentational components for rendering.

*Responsive and Accessible Design: Ensure the UI adapts to different devices and meets accessibility standards (e.g., ARIA roles, keyboard navigation, and proper contrast).

*Type Safety with TypeScript: Use TypeScript interfaces and types to ensure data consistency, reduce runtime errors.

*Single Responsibility Principle: Each component or function should have a single, well-defined purpose to improve clarity, testability, and scalability.

==What Needs to be Done?==
===Questionnaire Management Dashboard===

Displays a list of questionnaire types (Review, Metareview, Author Feedback, etc.)
* Each questionnaire type has a "+" button, which, when clicked, navigates to a new page for creating a specific rubric for that questionnaire type.
* Data is fetched dynamically from the backend.

[[File:Picx1x.png | 700px]]

===Create/Edit Rubric Page===

This page is displayed when a user clicks the "+" button from the dashboard.

Allows users to:
* Enter a name for the rubric.
* Define min/max item scores.
* Set the review visibility (private/public).
* Add criteria for evaluation.
* Submit the form to create a new rubric for the selected questionnaire type.

[[File:Picx2x.png | 700px]]

==Backend Integration==

The frontend interacts with several key resources exposed by the backend through a RESTful API. The structure of each model's associated database table lets us define Typescript interfaces, transform request/response payloads and promote type safety.

===Models===

====Questionnaire====

The <code>Questionnaire</code> model forms the foundation of the Create/Edit form functionality, storing necessary attributes for each questionnaire. These fields are used to construct a form for editing or creating a rubric and to prepopulate the form when editing an existing rubric.

The backend database also includes a table of <code>questionnaire_types</code>, access to which would allow the Questionnaire Management Dashboard to dynamically render all available categories of questionnaires and enable users to initiate the creation process based on a selected type.

{| class="wikitable"
! Attribute !! Description
|-
| id || Unique identifier for the questionnaire
|-
| name || The name/title of the questionnaire
|-
| instructor_id || Foreign key referencing the instructor who created it
|-
| private || Boolean indicating if the questionnaire is private
|-
| min_question_score || Minimum score that can be given to any question
|-
| max_question_score || Maximum score that can be given to any question
|-
| questionnaire_type || The type/category of questionnaire (e.g., Survey, Teammate Review)
|-
| display_type || Field for specifying how to display the questionnaire
|-
| instruction_loc || Field for custom instructions location or reference
|-
| created_at || Timestamp of questionnaire creation
|-
| updated_at || Timestamp of last update
|}

====Item====

The <code>Item</code> model represents individual items (or questions) within a questionnaire and includes attributes that should be included when adding an item to a particular questionnaire.

{| class="wikitable"
! Attribute !! Description
|-
| id || Unique identifier for the item
|-
| txt || The text of the item/question
|-
| weight || The relative importance or weight of the item
|-
| seq || The sequence/order of the item in the questionnaire
|-
| question_type || Foreign key referencing the type of question
|-
| size || Size attribute for text-based answers (e.g., text area size)
|-
| alternatives || Possible answer choices (comma-separated for multiple-choice)
|-
| break_before || Boolean indicating whether to insert a page break before the item
|-
| max_label || Optional label for the maximum scale value
|-
| min_label || Optional label for the minimum scale value
|-
| created_at || Timestamp of item creation
|-
| updated_at || Timestamp of last update
|-
| questionnaire_id || Foreign key referencing the associated questionnaire
|}

===API Endpoints===

To facilitate interaction with the backend, the frontend uses a pre-configured <code>axiosClient</code>, which abstracts the base API URL and port number. This client is defined in the <code>utils/axios_client.ts</code> file and reused throughout the project for API communication. For questionnaire management, several key API routes are accessed using this client. For example, <code>GET /questionnaires/:id</code> fetches detailed data for editing a selected questionnaire. When creating or updating a questionnaire, the application uses <code>POST /questionnaires</code> and <code>PUT /questionnaires/:id</code>, respectively.

{| class="wikitable"
|+
! HTTP Method !! Endpoint !! Description
|-
| GET || /questionnaires || Fetches a list of all questionnaires
|-
| GET || /questionnaires/:id || Fetches a specific questionnaire by ID
|-
| POST || /questionnaires || Creates a new questionnaire
|-
| PUT || /questionnaires/:id || Updates an existing questionnaire
|-
| DELETE || /questionnaires/:id || Deletes a specific questionnaire
|-
| GET || /questions || Retrieves a list of all questions (items)
|-
| GET || /questions/:id || Retrieves a specific item, along with its rendered display
|-
| POST || /questions || Creates a new item for a questionnaire
|-
| PUT || /questions/:id || Updates an existing item
|}

==Implementation==
===User Interface===

====Manage Questionnaires====

To navigate to the Questionnaire Management Dashboard, Questionnaire from the Manage dropdown from any page on Expertiza.

To be consistent with other management pages (for Users, Courses, Assignements) in the reimplementation front end, a table of questionnaires belonging to the logged-in instructor is visible on the page. From this page, you may create, edit, or delete a questionnaire.

To create a new questionnaire, click on the Create button in the top left corner of the page.

[[File:ManagementDashboard.png | 700px]]

====Type Selection====

When the Create button is selected from the top of the Questionnaire Management Dashboard, a pop-up appears with the available questionnaire types. To create a questionnaire of a given type, select the "+" botton in the row of the desired type.

[[File:TypeSelection.png | 700px]]

====Questionnaire Form====

Once a type has been selected, the user is directed to the appropriate form to create a questionnaire of the selected type. The user can include a variable number of items to the questionnaire at the time of creation. The required fields for an item is determined by the item type. For example, a scale type item required minimum and maximum values for its scale.

[[File:Questionnaire Form.png | 700px]]

Once a form field has been touched, the application alerts the user of missing required fields. Failure to provide appropriate values will prevent form submission.

[[File:Screenshot 2025-04-22 at 10.12.22 AM.png | 700px]]

Upon successful submission, the newly-created questionnaire will appear in the list of questionnaires in the Questionnaire Management Dashboard.

[[File:Editquestionnaireselect.png | 700px]]

To edit a questionnaire, select the edit icon next to the questionnaire you want to edit. You will be directed to a form with the existing questionnaire and items filled in.

[[File:Editquestionnaire.png | 700px]]

===QuestionnaireUtils.ts===
The <code>QuestionnaireUtils.ts</code> file serves as a utility module for handling questionnaire-related functionality in the application, including interfaces, data transformation methods, and back-end data retrieval. This file helps maintain clear separation of concerns, type safety, and adherence to design principles such as the Single Responsibility Principle (SRP).

===QuestionnaireForm.tsx===
The <code>QuestionnaireForm.tsx</code> file is a React component that provides a form interface for creating or editing questionnaires. It integrates with Formik for form state management and validation, utilizing React Bootstrap for UI elements.

The form fields are strongly typed using Formik's <code>Field</code> components and the <code>QuestionnaireFormValues</code> interface, ensuring that the data entered by the user adheres to the correct structure.
*Name: A text field for entering the questionnaire name.
*Type: A hidden input used to specify the type of the questionnaire selected from the Questionnaire Management Dashboard and to be passed to the back-end.
*Private: A checkbox to indicate whether the questionnaire is private.
*Minimum/Maximum Question Scores: Numeric fields for setting the minimum and maximum scores for questions.

The form delegates the responsibility of handling questionnaire items to the <code>QuestionnaireItemsFieldArray</code> component, which allows users to add or remove items dynamically and keeps each component focused on a single responsibility.

===QuestionnaireTypes.tsx===
This component renders a table that displays different types of questionnaires. Each row provides an action to navigate to the corresponding creation page for the selected questionnaire type. The <code>Table</code> component from <code>components/Table/Table</code> is used in adherence with the DRY Principle and the provided design guidelines.

==Code Changes Summary==
{| class="wikitable"
! File !! Method / Function !! Before !! After / Changes Introduced !! Commit Summary
|-
| App.tsx || Routing to /questionnaire and /edit-questionnaire || Not defined or incomplete || Added `ProtectedRoute` wrappers and proper routing to `Questionnaire` and `EditQuestionnaire` || Updated App.tsx
|-
| Questionnaire.tsx || render(), type grouping || Basic list display || Grouped by type, added "+" button for creating new rubrics || Update Questionnaire.tsx
|-
| Questionnaire.tsx || Add rubric handler || Not implemented || Clicking "+" navigates to `edit-questionnaire` with type parameter || More UI updates
|-
| EditQuestionnaire.tsx || Form handling & API integration || Static layout || Full integration with axios POST/PUT calls to backend || updated interface so it can now update backend
|-
| EditQuestionnaire.tsx || Questionnaire name editing || Not available || Name can now be edited from the UI || More functionality updates
|-
| EditQuestionnaire.tsx || Display and manage rubric items || Static list || Dynamically displays and adds rubric items || Properly displays items and properly adds items
|-
| questionnaire.tsx || Icons and UI elements || No icons || Edit, delete, and copy icons added for each row || More UI updates, including icons
|-
| axios_client.ts || axios client usage || Not standardized || Shared axiosClient used for API calls across all pages || Integrated across changes
|}

==Files Modified==
The following files were created or modified to implement the questionnaire dashboard and rubric management UI in React with TypeScript:

*<code>src/pages/Questionnaire/questionnaire.tsx</code> – Implements the Questionnaire Management Dashboard UI and groups questionnaires by type with "+" action buttons.
*<code>src/pages/EditQuestionnaire/Questionnaire.tsx</code> – Create/Edit Rubric page that handles full form logic and submission.
*<code>src/App.tsx</code> – Updated routing to include new paths: <code>/questionnaire</code> and <code>/edit-questionnaire</code>, protected via <code>ProtectedRoute</code>.
*<code>src/assets/icons/</code> – Added new UI icons for edit, delete, and copy actions in the questionnaire list.
*<code>src/utils/axios_client.ts</code> – Preconfigured <code>axios</code> instance used throughout the frontend for API interactions.
*<code>package.json</code> and <code>package-lock.json</code> – Updated dependencies for React Bootstrap, Formik, and icon support.

Note: The previously separate files like <code>QuestionnaireForm.tsx</code>, <code>QuestionnaireItemsFieldArray.tsx</code>, and <code>QuestionnaireUtils.tsx</code> were refactored and consolidated into <code>EditQuestionnaire/Questionnaire.tsx</code> for improved maintainability.

==Test Plan - Manual Testing Strategy==
====Login Credentials====
To login to the application, use the following credentials:
* username: instructor6
* password: password

====Questionnaire Dashboard Loading====
* Visit <code>/questionnaire</code> and confirm that all types of questionnaires are displayed.
* "+" button next to each type should open the rubric creation form with the correct type preselected.

====Form Functionality====
* Enter name, min/max scores, and toggle the private/public checkbox.
* Dynamically add or remove criteria.
* Submit the form to create a new rubric and confirm it reflects on the dashboard.

====Edit Rubric====
* Click on an existing rubric's "Edit" icon to load it in the edit form.
* Modify any field (name, score range, criteria) and resubmit.
* Confirm updated rubric details persist and are displayed correctly.

====Form Validation====
* Leave required fields empty and confirm that validation messages are displayed.
* Enter invalid values (e.g., <code>max_score < min_score</code>) and confirm appropriate warnings are shown.

====API Communication====
* Verify that form submissions trigger <code>POST /questionnaires</code> or <code>PUT /questionnaires/:id</code>.
* Confirm that response handling updates the UI appropriately (e.g., rerenders list on successful save).

====UI Testing====
* Confirm that the layout is responsive across desktop, tablet, and mobile devices.
* Ensure accessibility: keyboard navigation works, form fields are properly labeled, and ARIA roles are used where needed.

==Team==
=====Mentor=====
*Prathyusha Kodali - pkodali

=====Members=====
*Ashwin Muniswamy - akumarm
*Michael Anderson - mwander5
*Martina Viola - mmviola

==Reference Links==
*[https://expertiza.ncsu.edu/tree_display/list?currCtlr=Questionnaires Questionnaire Management Dashboard]
*[https://expertiza.ncsu.edu/questionnaires/new?model=ReviewQuestionnaire&private=1 Create/Edit Rubric Page]
*[https://github.com/Michael-Anderson-NCSU/reimplementation-front-end Project Repo]
*[http://152.7.176.255:8080 VCL Deployment]
*[https://github.com/expertiza/reimplementation-front-end/pull/98 Pull Request]

=====Demo Video=====
*[https://youtu.be/eVViM9_Gg80, Demo Video]

CSC/ECE 517 Spring 2025 - E2538 Reimplementing Questionnaire Page in Expertiza

2025-04-22T22:08:42Z

Mwander5: /* Reference Links */

==E2538 Reimplementing Questionnaire Page==

__TOC__

==About Expertiza==
Expertiza is an open-source web application currently built using [http://rubyonrails.org/ Ruby on Rails] and led by [https://www.csc.ncsu.edu/people/efg Dr. Edward Gehringer]. Designed for educational use, it enables instructors to manage assignments, rubrics, and participants, as well as assign grades and monitor student progress. Students can submit various types of learning objects, form teams, conduct peer evaluations, and review feedback from both peers and instructors. Originally developed at NC State, Expertiza is now used in select courses there and by faculty at other institutions, offering a flexible platform to enhance active learning and feedback in academic settings.

The reimplementation of Expertiza aims to mimic and enhance the application’s existing functionality with clean, well-structured code, while transitioning to a front-end application written in React and Typescipt integrated with a Ruby on Rails back-end.

==Project Overview==
The goal of this project is to implement the Questionnaire Management Dashboard and Create/Edit Rubric pages in Expertiza by reimplementing its frontend using React with TypeScript, while integrating it with the existing Ruby on Rails backend APIs in the reimplementation backend repo. The new implementation will improve user experience, maintainability, and scalability while preserving core functionalities.

This project covers:

* Developing a React-based UI for managing questionnaire rubrics.

* Enabling navigation to a new page when clicking the "+" button to create a specific rubric for a questionnaire type.

* Ensuring seamless API integration with the reimplementation backend repo.

* Managing user sessions and authentication securely.

While adhering to the following best practices:

*Component Reusability (DRY Principle): Design reusable and modular components to avoid duplication and simplify maintenance, adhering to the "Don't Repeat Yourself" principle.

*Separation of Concerns: Keep the UI, state management, and business logic separated. Use container components for state and logic and presentational components for rendering.

*Responsive and Accessible Design: Ensure the UI adapts to different devices and meets accessibility standards (e.g., ARIA roles, keyboard navigation, and proper contrast).

*Type Safety with TypeScript: Use TypeScript interfaces and types to ensure data consistency, reduce runtime errors.

*Single Responsibility Principle: Each component or function should have a single, well-defined purpose to improve clarity, testability, and scalability.

==What Needs to be Done?==
===Questionnaire Management Dashboard===

Displays a list of questionnaire types (Review, Metareview, Author Feedback, etc.)
* Each questionnaire type has a "+" button, which, when clicked, navigates to a new page for creating a specific rubric for that questionnaire type.
* Data is fetched dynamically from the backend.

[[File:Picx1x.png | 700px]]

===Create/Edit Rubric Page===

This page is displayed when a user clicks the "+" button from the dashboard.

Allows users to:
* Enter a name for the rubric.
* Define min/max item scores.
* Set the review visibility (private/public).
* Add criteria for evaluation.
* Submit the form to create a new rubric for the selected questionnaire type.

[[File:Picx2x.png | 700px]]

==Backend Integration==

The frontend interacts with several key resources exposed by the backend through a RESTful API. The structure of each model's associated database table lets us define Typescript interfaces, transform request/response payloads and promote type safety.

===Models===

====Questionnaire====

The <code>Questionnaire</code> model forms the foundation of the Create/Edit form functionality, storing necessary attributes for each questionnaire. These fields are used to construct a form for editing or creating a rubric and to prepopulate the form when editing an existing rubric.

The backend database also includes a table of <code>questionnaire_types</code>, access to which would allow the Questionnaire Management Dashboard to dynamically render all available categories of questionnaires and enable users to initiate the creation process based on a selected type.

{| class="wikitable"
! Attribute !! Description
|-
| id || Unique identifier for the questionnaire
|-
| name || The name/title of the questionnaire
|-
| instructor_id || Foreign key referencing the instructor who created it
|-
| private || Boolean indicating if the questionnaire is private
|-
| min_question_score || Minimum score that can be given to any question
|-
| max_question_score || Maximum score that can be given to any question
|-
| questionnaire_type || The type/category of questionnaire (e.g., Survey, Teammate Review)
|-
| display_type || Field for specifying how to display the questionnaire
|-
| instruction_loc || Field for custom instructions location or reference
|-
| created_at || Timestamp of questionnaire creation
|-
| updated_at || Timestamp of last update
|}

====Item====

The <code>Item</code> model represents individual items (or questions) within a questionnaire and includes attributes that should be included when adding an item to a particular questionnaire.

{| class="wikitable"
! Attribute !! Description
|-
| id || Unique identifier for the item
|-
| txt || The text of the item/question
|-
| weight || The relative importance or weight of the item
|-
| seq || The sequence/order of the item in the questionnaire
|-
| question_type || Foreign key referencing the type of question
|-
| size || Size attribute for text-based answers (e.g., text area size)
|-
| alternatives || Possible answer choices (comma-separated for multiple-choice)
|-
| break_before || Boolean indicating whether to insert a page break before the item
|-
| max_label || Optional label for the maximum scale value
|-
| min_label || Optional label for the minimum scale value
|-
| created_at || Timestamp of item creation
|-
| updated_at || Timestamp of last update
|-
| questionnaire_id || Foreign key referencing the associated questionnaire
|}

===API Endpoints===

To facilitate interaction with the backend, the frontend uses a pre-configured <code>axiosClient</code>, which abstracts the base API URL and port number. This client is defined in the <code>utils/axios_client.ts</code> file and reused throughout the project for API communication. For questionnaire management, several key API routes are accessed using this client. For example, <code>GET /questionnaires/:id</code> fetches detailed data for editing a selected questionnaire. When creating or updating a questionnaire, the application uses <code>POST /questionnaires</code> and <code>PUT /questionnaires/:id</code>, respectively.

{| class="wikitable"
|+
! HTTP Method !! Endpoint !! Description
|-
| GET || /questionnaires || Fetches a list of all questionnaires
|-
| GET || /questionnaires/:id || Fetches a specific questionnaire by ID
|-
| POST || /questionnaires || Creates a new questionnaire
|-
| PUT || /questionnaires/:id || Updates an existing questionnaire
|-
| DELETE || /questionnaires/:id || Deletes a specific questionnaire
|-
| GET || /questions || Retrieves a list of all questions (items)
|-
| GET || /questions/:id || Retrieves a specific item, along with its rendered display
|-
| POST || /questions || Creates a new item for a questionnaire
|-
| PUT || /questions/:id || Updates an existing item
|}

==Implementation==
===User Interface===

====Manage Questionnaires====

To navigate to the Questionnaire Management Dashboard, Questionnaire from the Manage dropdown from any page on Expertiza.

To be consistent with other management pages (for Users, Courses, Assignements) in the reimplementation front end, a table of questionnaires belonging to the logged-in instructor is visible on the page. From this page, you may create, edit, or delete a questionnaire.

To create a new questionnaire, click on the Create button in the top left corner of the page.

[[File:ManagementDashboard.png | 700px]]

====Type Selection====

When the Create button is selected from the top of the Questionnaire Management Dashboard, a pop-up appears with the available questionnaire types. To create a questionnaire of a given type, select the "+" botton in the row of the desired type.

[[File:TypeSelection.png | 700px]]

====Questionnaire Form====

Once a type has been selected, the user is directed to the appropriate form to create a questionnaire of the selected type. The user can include a variable number of items to the questionnaire at the time of creation. The required fields for an item is determined by the item type. For example, a scale type item required minimum and maximum values for its scale.

[[File:Questionnaire Form.png | 700px]]

Once a form field has been touched, the application alerts the user of missing required fields. Failure to provide appropriate values will prevent form submission.

[[File:Screenshot 2025-04-22 at 10.12.22 AM.png | 700px]]

Upon successful submission, the newly-created questionnaire will appear in the list of questionnaires in the Questionnaire Management Dashboard.

[[File:Editquestionnaireselect.png | 700px]]

To edit a questionnaire, select the edit icon next to the questionnaire you want to edit. You will be directed to a form with the existing questionnaire and items filled in.

[[File:Editquestionnaire.png | 700px]]

===QuestionnaireUtils.ts===
The <code>QuestionnaireUtils.ts</code> file serves as a utility module for handling questionnaire-related functionality in the application, including interfaces, data transformation methods, and back-end data retrieval. This file helps maintain clear separation of concerns, type safety, and adherence to design principles such as the Single Responsibility Principle (SRP).

===QuestionnaireForm.tsx===
The <code>QuestionnaireForm.tsx</code> file is a React component that provides a form interface for creating or editing questionnaires. It integrates with Formik for form state management and validation, utilizing React Bootstrap for UI elements.

The form fields are strongly typed using Formik's <code>Field</code> components and the <code>QuestionnaireFormValues</code> interface, ensuring that the data entered by the user adheres to the correct structure.
*Name: A text field for entering the questionnaire name.
*Type: A hidden input used to specify the type of the questionnaire selected from the Questionnaire Management Dashboard and to be passed to the back-end.
*Private: A checkbox to indicate whether the questionnaire is private.
*Minimum/Maximum Question Scores: Numeric fields for setting the minimum and maximum scores for questions.

The form delegates the responsibility of handling questionnaire items to the <code>QuestionnaireItemsFieldArray</code> component, which allows users to add or remove items dynamically and keeps each component focused on a single responsibility.

===QuestionnaireTypes.tsx===
This component renders a table that displays different types of questionnaires. Each row provides an action to navigate to the corresponding creation page for the selected questionnaire type. The <code>Table</code> component from <code>components/Table/Table</code> is used in adherence with the DRY Principle and the provided design guidelines.

==Code Changes Summary==
{| class="wikitable"
! File !! Method / Function !! Before !! After / Changes Introduced !! Commit Summary
|-
| App.tsx || Routing to /questionnaire and /edit-questionnaire || Not defined or incomplete || Added `ProtectedRoute` wrappers and proper routing to `Questionnaire` and `EditQuestionnaire` || Updated App.tsx
|-
| Questionnaire.tsx || render(), type grouping || Basic list display || Grouped by type, added "+" button for creating new rubrics || Update Questionnaire.tsx
|-
| Questionnaire.tsx || Add rubric handler || Not implemented || Clicking "+" navigates to `edit-questionnaire` with type parameter || More UI updates
|-
| EditQuestionnaire.tsx || Form handling & API integration || Static layout || Full integration with axios POST/PUT calls to backend || updated interface so it can now update backend
|-
| EditQuestionnaire.tsx || Questionnaire name editing || Not available || Name can now be edited from the UI || More functionality updates
|-
| EditQuestionnaire.tsx || Display and manage rubric items || Static list || Dynamically displays and adds rubric items || Properly displays items and properly adds items
|-
| questionnaire.tsx || Icons and UI elements || No icons || Edit, delete, and copy icons added for each row || More UI updates, including icons
|-
| axios_client.ts || axios client usage || Not standardized || Shared axiosClient used for API calls across all pages || Integrated across changes
|}

==Files Modified==
The following files were created or modified to implement the questionnaire dashboard and rubric management UI in React with TypeScript:

*<code>src/pages/Questionnaire/questionnaire.tsx</code> – Implements the Questionnaire Management Dashboard UI and groups questionnaires by type with "+" action buttons.
*<code>src/pages/EditQuestionnaire/Questionnaire.tsx</code> – Create/Edit Rubric page that handles full form logic and submission.
*<code>src/App.tsx</code> – Updated routing to include new paths: <code>/questionnaire</code> and <code>/edit-questionnaire</code>, protected via <code>ProtectedRoute</code>.
*<code>src/assets/icons/</code> – Added new UI icons for edit, delete, and copy actions in the questionnaire list.
*<code>src/utils/axios_client.ts</code> – Preconfigured <code>axios</code> instance used throughout the frontend for API interactions.
*<code>package.json</code> and <code>package-lock.json</code> – Updated dependencies for React Bootstrap, Formik, and icon support.

Note: The previously separate files like <code>QuestionnaireForm.tsx</code>, <code>QuestionnaireItemsFieldArray.tsx</code>, and <code>QuestionnaireUtils.tsx</code> were refactored and consolidated into <code>EditQuestionnaire/Questionnaire.tsx</code> for improved maintainability.

==Test Plan - Manual Testing Strategy==
====Login Credentials====
To login to the application, use the following credentials:
* username: instructor6
* password: password

====Questionnaire Dashboard Loading====
* Visit <code>/questionnaire</code> and confirm that all types of questionnaires are displayed.
* "+" button next to each type should open the rubric creation form with the correct type preselected.

====Form Functionality====
* Enter name, min/max scores, and toggle the private/public checkbox.
* Dynamically add or remove criteria.
* Submit the form to create a new rubric and confirm it reflects on the dashboard.

====Edit Rubric====
* Click on an existing rubric's "Edit" icon to load it in the edit form.
* Modify any field (name, score range, criteria) and resubmit.
* Confirm updated rubric details persist and are displayed correctly.

====Form Validation====
* Leave required fields empty and confirm that validation messages are displayed.
* Enter invalid values (e.g., <code>max_score < min_score</code>) and confirm appropriate warnings are shown.

====API Communication====
* Verify that form submissions trigger <code>POST /questionnaires</code> or <code>PUT /questionnaires/:id</code>.
* Confirm that response handling updates the UI appropriately (e.g., rerenders list on successful save).

====UI Testing====
* Confirm that the layout is responsive across desktop, tablet, and mobile devices.
* Ensure accessibility: keyboard navigation works, form fields are properly labeled, and ARIA roles are used where needed.

==Team==
=====Mentor=====
*Prathyusha Kodali - pkodali

=====Members=====
*Ashwin Muniswamy - akumarm
*Michael Anderson - mwander5
*Martina Viola - mmviola

==Reference Links==
*[https://expertiza.ncsu.edu/tree_display/list?currCtlr=Questionnaires Questionnaire Management Dashboard]
*[https://expertiza.ncsu.edu/questionnaires/new?model=ReviewQuestionnaire&private=1 Create/Edit Rubric Page]
*[https://github.com/Michael-Anderson-NCSU/reimplementation-front-end Project Repo]
*[http://152.7.176.255:8080 VCL Deployment]
*[https://github.com/expertiza/reimplementation-front-end/pull/98, Pull Request]

=====Demo Video=====
*[https://youtu.be/eVViM9_Gg80, Demo Video]

CSC/ECE 517 Spring 2025 - E2538 Reimplementing Questionnaire Page in Expertiza

2025-04-02T21:41:49Z

Mwander5:

==E2538 Reimplementing Questionnaire Page==

__TOC__

==Expertiza==
In accordance with the [http://rubyonrails.org/ Ruby on Rails] framework, [http://expertiza.ncsu.edu/ Expertiza] is an open source software project (OSS) led by [https://www.csc.ncsu.edu/people/efg Dr. Edward Gehringer]. Through this platform, the instructor can add and edit assignments that students are able to view and contribute to. There are various filtering methods that streamline this process. There is also the ability for students to peer review other students to give contributing feedback.

==Project Requirement==
The goal of this project is to implement the Questionnaire Page in Expertiza by reimplementing its frontend using React with TypeScript, while integrating it with the existing Ruby on Rails backend APIs in the reimplementation backend repo. The new implementation will improve user experience, maintainability, and scalability while preserving core functionalities.

This project covers:

* Developing a React-based UI for managing questionnaire rubrics.

* Enabling navigation to a new page when clicking the "+" button to create a specific rubric for a questionnaire type.

* Ensuring seamless API integration with the reimplementation backend repo.

* Managing user sessions and authentication securely.

==Best Practices==
*Component Reusability (DRY Principle): Design reusable and modular components to avoid duplication and simplify maintenance, adhering to the "Don't Repeat Yourself" principle.

*Separation of Concerns: Keep the UI, state management, and business logic separated. Use container components for state and logic and presentational components for rendering.

*Responsive and Accessible Design: Ensure the UI adapts to different devices and meets accessibility standards (e.g., ARIA roles, keyboard navigation, and proper contrast).

*Type Safety with TypeScript: Use TypeScript interfaces and types to ensure data consistency, reduce runtime errors.

*Single Responsibility Principle: Each component or function should have a single, well-defined purpose to improve clarity, testability, and scalability.

==What Needs to be Done?==
===Questionnaire Management Dashboard===

Displays a list of questionnaire types (Review, Metareview, Author Feedback, etc.)
* Each questionnaire type has a "+" button, which, when clicked, navigates to a new page for creating a specific rubric for that questionnaire type.
* Data is fetched dynamically from the backend.

[[File:Picx1x.png | 700px]]

===Create/Edit Rubric Page===

This page is displayed when a user clicks the "+" button from the dashboard.

Allows users to:
* Enter a name for the rubric.
* Define min/max item scores.
* Set the review visibility (private/public).
* Add criteria for evaluation.
* Submit the form to create a new rubric for the selected questionnaire type.

[[File:Picx2x.png | 700px]]

==Class UML Diagram==

==Implementation==
===Views===
===Model===
===Controller===

==Files Modified==

==Test Plan==
===Testing Views===
===Testing Model===
===Testing Controller===

==Test Coverage==

==Team==
=====Mentor=====
*Prathyusha Kodali - pkodali

=====Members=====
*Ashwin Muniswamy - akumarm
*Michael Anderson - mwander5
*Martina Viola - mmviola

==Reference Links==
*[https://expertiza.ncsu.edu/tree_display/list?currCtlr=Questionnaires, Questionnaire Management Dashboard]
*[https://expertiza.ncsu.edu/questionnaires/new?model=ReviewQuestionnaire&private=1, Create/Edit Rubric Page]

CSC/ECE 517 Spring 2025 - E2538 Reimplementing Questionnaire Page in Expertiza

2025-04-02T21:39:27Z

Mwander5: /* Reference Links */

==Project Requirement==
The goal of this project is to implement the Questionnaire Page in Expertiza by reimplementing its frontend using React with TypeScript, while integrating it with the existing Ruby on Rails backend APIs in the reimplementation backend repo. The new implementation will improve user experience, maintainability, and scalability while preserving core functionalities.

This project covers:

* Developing a React-based UI for managing questionnaire rubrics.

* Enabling navigation to a new page when clicking the "+" button to create a specific rubric for a questionnaire type.

* Ensuring seamless API integration with the reimplementation backend repo.

* Managing user sessions and authentication securely.

==Best Practices==
*Component Reusability (DRY Principle): Design reusable and modular components to avoid duplication and simplify maintenance, adhering to the "Don't Repeat Yourself" principle.

*Separation of Concerns: Keep the UI, state management, and business logic separated. Use container components for state and logic and presentational components for rendering.

*Responsive and Accessible Design: Ensure the UI adapts to different devices and meets accessibility standards (e.g., ARIA roles, keyboard navigation, and proper contrast).

*Type Safety with TypeScript: Use TypeScript interfaces and types to ensure data consistency, reduce runtime errors.

*Single Responsibility Principle: Each component or function should have a single, well-defined purpose to improve clarity, testability, and scalability.

==What Needs to be Done?==
===Questionnaire Management Dashboard===

Displays a list of questionnaire types (Review, Metareview, Author Feedback, etc.)
* Each questionnaire type has a "+" button, which, when clicked, navigates to a new page for creating a specific rubric for that questionnaire type.
* Data is fetched dynamically from the backend.

[[File:Picx1x.png | 700px]]

===Create/Edit Rubric Page===

This page is displayed when a user clicks the "+" button from the dashboard.

Allows users to:
* Enter a name for the rubric.
* Define min/max item scores.
* Set the review visibility (private/public).
* Add criteria for evaluation.
* Submit the form to create a new rubric for the selected questionnaire type.

[[File:Picx2x.png | 700px]]

==Class UML Diagram==

==Implementation==
===Views===
===Model===
===Controller===

==Files Modified==

==Test Plan==
===Testing Views===
===Testing Model===
===Testing Controller===

==Test Coverage==

==Team==
=====Mentor=====
*Prathyusha Kodali - pkodali

=====Members=====
*Ashwin Muniswamy - akumarm
*Michael Anderson - mwander5
*Martina Viola - mmviola

==Reference Links==
*[https://expertiza.ncsu.edu/tree_display/list?currCtlr=Questionnaires, Questionnaire Management Dashboard]
*[https://expertiza.ncsu.edu/questionnaires/new?model=ReviewQuestionnaire&private=1, Create/Edit Rubric Page]

CSC/ECE 517 Spring 2025

2025-04-01T19:23:39Z

Mwander5:

* [[CSC/ECE 517 Spring 2025 - E2503. Refactor the Team hierarchy]]
* [[CSC/ECE 517 Spring 2025 - E2504. Mentor-meeting management]]
* [[CSC/ECE 517 Spring 2025 - E2505. Testing Answer Tagging]]
* [[CSC/ECE 517 Spring 2025 - E2508. Reimplement bidding-algorithm web service]]
* [[CSC/ECE 517 Spring 2025 - E2509. Reimplement feedback_response_map.rb]]
* [[CSC/ECE 517 Spring 2025 - E2519. Implement view for results of bidding]]
* [[CSC/ECE 517 Spring 2025 - E2522. Enhancing UI Consistency in Expertiza 1]]
* [[CSC/ECE 517 Spring 2025 - E2520. Reimplement heatgrid UI for reviews]]
* [[CSC/ECE 517 Spring 2025 - E2517. Reimplement internationalization (frontend + backend)]]
* [[CSC/ECE 517 Spring 2025 - E2523: Enhancing UI Consistency in Expertiza 2]]
* [[CSC/ECE 517 Spring 2025 - E2515: Reimplement student_teams_controller.rb]]
* [[CSC/ECE 517 Spring 2025 - E2501: Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Spring 2025 - E2502: Refactor review_mapping_controller.rb]]
* [[CSC/ECE 517 Spring 2025 - E2512. Reimplement responses controller]]
* [[CSC/ECE 517 Spring 2025 - E2510. Reimplement grades_controller.rb]]
* [[CSC/ECE 517 Spring 2025 - E2507. Reimplement back end for submission records]]
* [[CSC/ECE 517 Spring 2025 - E2514. Reimplement student_quizzes_controller.rb]]
* [[CSC/ECE 517 Spring 2025 - E2518. Reimplement password resets (frontend + backend)]]
* [[CSC/ECE 517 Spring 2025 - E2516. Reimplement teams_users_controller.rb]]
* [[CSC/ECE 517 Spring 2025 - E2511. Reimplement participants_controller.rb]]
* [[CSC/ECE 517 Spring 2025 - E2521. UI for View submissions/assign grades (except heatgrid)]]
* [[CSC/ECE 517 Spring 2025 - E2513. Reimplement sign_up_topic.rb as project_topic.rb]]
* [[CSC/ECE 517 Spring 2025 - E2506. Implement testing for new Bookmarks Controller]]
* [[CSC/ECE 517 Spring 2025 - E2527. Mentor-meeting management: assignments with topics]]
* [[CSC/ECE 517 Spring 2025 - E2532. Reimplement Missing ResponseMap Subclasses]]
* [[CSC/ECE 517 Spring 2025 - E2538 Reimplementing Questionnaire Page in Expertiza]]

CSC/ECE 517 Spring 2025 - E2505. Testing Answer Tagging

2025-03-24T17:04:49Z

Mwander5: /* tag_prompt_deployment_spec.rb */

==E2505. Testing - Answer Tagging==

This wiki page is for the description of changes made in Spring 2025, CSC/ECE 517 for the E2505 Testing - Testing Answer Tagging.

__TOC__

==Expertiza==
In accordance with the [http://rubyonrails.org/ Ruby on Rails] framework, [http://expertiza.ncsu.edu/ Expertiza] is an open source software project (OSS) led by [https://www.csc.ncsu.edu/people/efg Dr. Edward Gehringer]. Through this platform, the instructor can add and edit assignments that students are able to view and contribute to. There are various filtering methods that streamline this process. There is also the ability for students to peer review other students to give contributing feedback.

==Objective==
Our objective is to test two files which are part of this process. We are testing a controller for answer tags DESCRIBE ANSWER TAGS HERE EDIT ME. As well as a model for tag prompt deployment which interfaces with this answer tags controller which has methods that return various information about a students progress in tagging answers.

==Controller and Spec Files==
Answer Tags
* [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/answer_tags_controller.rb answer_tags_controller.rb] with initial coverage of 0%
* [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/controllers/answer_tags_controller_spec.rb answer_tags_controller_spec.rb]

Tag Prompt Deployment
* [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/tag_prompts_controller.rb tag_prompt_deployment.rb] with initial coverage of 17.65%
* [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/models/tag_prompt_deployment_spec.rb tag_prompt_deployment_spec.rb]

==Testing Implementation==
===Answer Tags Controller===
This controller [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/app/controllers/answer_tags_controller.rb] creates/edits answer tags and tracks the number of tags a student has completed overall per assignment or questionnaire. The controller filters based on assignment_id, questionnaire_id and user_id to present appropriate records. The controllers' output is a JSON-formatted collection of response tags.

=====Methods=====
''action_allowed?'' : Determines whether the current user is permitted to access the given action (index or create_edit) based on their role.

: Use Cases:

:: - When it is a student session, access to index should be allowed.
:: - When it is a student session, access to create_edit should be allowed.
:: - When the session user is a student, access to unsupported actions like destroy or show should be denied.

: Edge Cases:

:: - When the session is not defined, access to any action (e.g., index, create_edit) should be denied.
:: - When a user with no role assigned tries to access index or create_edit, access should be denied.
:: - When an Instructor tries to access an unsupported action (e.g., destroy), access should be denied.
:: - When the action parameter is missing or unrecognized, access should be denied regardless of user role.

''index'' : Returns all the tag prompt deployments in JSON format

: Use Cases:

: * For any authenticated user above student access:
:: - When anyone above student privilege is authorized
:: - When there are no tag prompts deployed, a empty list should be displayed.
:: - When there is 1 tag prompt deployed, 1 should be displayed.
:: - When there are tag prompts deployed with no associated assignment answer tag, tag prompts should not be displayed.
:: - When there is an answer tag associated with an user_id, it should be filtered by an user_id.
:: - When there is an answer tag associated with an assignment_id, it should be filtered by an assignment_id.
:: - When there is an answer tag associated with a questionnaire_id, it should be filtered by a questionnaire_id.
:: - When there is an answer tag associated with an user_id, assignment_id, and questionnaire_id, it should be filtered by a user_id, assignment_id, questionnaire_id.
:: - When there is no answer tag associated with a assignment_id, no tag prompts are returned for a assignment_id with no associated answer tags.
:: - When there is no answer tag associated with a questionnaire_id, no tag prompts are returned for a questionnaire_id with no associated answer tags.
:: - When provided with both assignment_id and questionnaire_id, it should provide the correct filtered response.
:: - When provided with one incorrect and one correct param, then no records should be returned.
: * When there are multiple tags are present for an assignment, all related tags should be returned.
: * When a user request is made, it should return records related to current user only.

: Edge Cases:

: * When user_id is undefined, an empty list of tags prompts should be returned.
: * When assignment_id is undefined, an empty list of tags prompts should be returned.
: * When questionnaire_id is undefined, an empty list of tags prompts should be returned.
: * When an unauthorized user tries to access the #index, the user should be returned to root_page.
: * When an invalid parameter is passed, the system should not break and should return valid results.
: * When there are large number of answer tags, the tags are handled properly.

''create_edit'' : Allows the creation or updating of an answer tag for the current student.

: Use Cases:

:: - When a valid combination of answer_id, tag_prompt_deployment_id, and value is provided by a student and no existing tag exists, a new AnswerTag is created.
:: - When a student accesses an existing tag, the tag is updated with the new provided value.
:: - When a student provides a user_id in the parameters, the controller still uses the current_user to ensure tags are associated only with the logged-in student.
:: - When create_edit is called multiple times with the same parameters, it does not create duplicate AnswerTag records — the existing one is updated.

: Edge Cases:
:: - When no answer_id is provided, the system raises an error and does not create or update the tag.
:: - When no tag_prompt_deployment_id is provided, the system raises an error.
:: - When no value is provided, the tag creation/update is rejected with an error.
:: - When incorrect or unexpected user_id is passed, it is ignored, and the tag is created for the current_user.

===Tag Prompt Deployment Controller===
The controller [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/app/models/tag_prompt_deployment.rb] is used by an instructor to view the tagging summary of the users that completed the answer tagging. It also indicates that comments are to be tagged for the characteristic specified by the tag prompt.
=====Methods=====
''tag_prompt'' : Tests that the tag prompt associated with the provided tag_prompt_id is correctly returned by the tag_dep.tag_prompt method.

: Use Cases:
: * When given a valid tag_prompt_id, it should return the associated tag prompt with the deployment.

: Edge Cases:
: * When given an invalid tag_prompt_id, it should not return a tag prompt with the deployment.

''get_number_of_taggable_answers'' : Calculates total taggable answers assigned for a user who participated in ``tag review assignment.''

: Use Cases:
: * When user_id is nil, it should return an error message.
: * When answer_length_threshold is null, it should return a count of tangible answers.
: * When answer_length_threshold is not null, it should return a count of taggable answers less than answers_one.

: Edge Cases:
: * When there are no responses, it should return zero as the count of taggable answers.
: * When questions are empty, it should return count of taggable answers as zero.

''assignment_tagging_progress'' : Accesses the percentage progress of answer tagging.

: Use Cases:
: * When there is a team, a question, and the assignment's rubrics do not vary by round, it should calculate the tagging progress for each user.
: * When there is a team, a question, and the assignment's rubrics do vary by round, it should calculate the tagging progress for each user considering all tagged items.

: Edge Cases:
: * When no questions are found, it should return an empty list.
: * When there are no teams or questions, it should return an empty list.

==Testing Details==
====Demo Videos====
# [https://drive.google.com/file/d/1UTeJC7oc8pbWZeOuCZt3JcdfW5uDv3Fu/view?usp=drive_link Demo Video for Tag Prompt Deployment Controller]

====Using RSpec====

We implemented tests in [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/controllers/answer_tags_controller_spec.rb answer_tags_controller_spec.rb] and [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/models/tag_prompt_deployment_spec.rb tag_prompt_deployment_spec.rb].

=====How to See Test Coverage=====
# Run RSpec for [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/controllers/answer_tags_controller_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

# Run RSpec for [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/models/tag_prompt_deployment_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

==Results==
Both files are 100% covered and additional testing was added to ensure a solid groundwork.

====answer_tags_controller_spec.rb====

: Coverage: 100%
: Hits/line: 63.1

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

====tag_prompt_deployment_spec.rb====

: Coverage: 100%
: Hits/line: 5.2

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

==Future Work==
1. Modify base files
a. correct several method names (ex: not named after a verb (assignment_tagging_progress))
b. make tag_prompt_deployment.rb more readable and better commented
c. Break some methods down into smaller ones for better functionality (assignment_tagging_progress)

==References==
# [https://github.com/expertiza/expertiza Expertiza GitHub]
# [https://github.com/Michael-Anderson-NCSU/expertiza Project Repository]
# [https://github.com/expertiza/expertiza/pull/2936 Pull Request]
# [https://www.theodinproject.com/lessons/ruby-introduction-to-rspec RSpec]

CSC/ECE 517 Spring 2025 - E2505. Testing Answer Tagging

2025-03-24T17:04:44Z

Mwander5: /* answer_tags_controller_spec.rb */

==E2505. Testing - Answer Tagging==

This wiki page is for the description of changes made in Spring 2025, CSC/ECE 517 for the E2505 Testing - Testing Answer Tagging.

__TOC__

==Expertiza==
In accordance with the [http://rubyonrails.org/ Ruby on Rails] framework, [http://expertiza.ncsu.edu/ Expertiza] is an open source software project (OSS) led by [https://www.csc.ncsu.edu/people/efg Dr. Edward Gehringer]. Through this platform, the instructor can add and edit assignments that students are able to view and contribute to. There are various filtering methods that streamline this process. There is also the ability for students to peer review other students to give contributing feedback.

==Objective==
Our objective is to test two files which are part of this process. We are testing a controller for answer tags DESCRIBE ANSWER TAGS HERE EDIT ME. As well as a model for tag prompt deployment which interfaces with this answer tags controller which has methods that return various information about a students progress in tagging answers.

==Controller and Spec Files==
Answer Tags
* [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/answer_tags_controller.rb answer_tags_controller.rb] with initial coverage of 0%
* [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/controllers/answer_tags_controller_spec.rb answer_tags_controller_spec.rb]

Tag Prompt Deployment
* [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/tag_prompts_controller.rb tag_prompt_deployment.rb] with initial coverage of 17.65%
* [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/models/tag_prompt_deployment_spec.rb tag_prompt_deployment_spec.rb]

==Testing Implementation==
===Answer Tags Controller===
This controller [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/app/controllers/answer_tags_controller.rb] creates/edits answer tags and tracks the number of tags a student has completed overall per assignment or questionnaire. The controller filters based on assignment_id, questionnaire_id and user_id to present appropriate records. The controllers' output is a JSON-formatted collection of response tags.

=====Methods=====
''action_allowed?'' : Determines whether the current user is permitted to access the given action (index or create_edit) based on their role.

: Use Cases:

:: - When it is a student session, access to index should be allowed.
:: - When it is a student session, access to create_edit should be allowed.
:: - When the session user is a student, access to unsupported actions like destroy or show should be denied.

: Edge Cases:

:: - When the session is not defined, access to any action (e.g., index, create_edit) should be denied.
:: - When a user with no role assigned tries to access index or create_edit, access should be denied.
:: - When an Instructor tries to access an unsupported action (e.g., destroy), access should be denied.
:: - When the action parameter is missing or unrecognized, access should be denied regardless of user role.

''index'' : Returns all the tag prompt deployments in JSON format

: Use Cases:

: * For any authenticated user above student access:
:: - When anyone above student privilege is authorized
:: - When there are no tag prompts deployed, a empty list should be displayed.
:: - When there is 1 tag prompt deployed, 1 should be displayed.
:: - When there are tag prompts deployed with no associated assignment answer tag, tag prompts should not be displayed.
:: - When there is an answer tag associated with an user_id, it should be filtered by an user_id.
:: - When there is an answer tag associated with an assignment_id, it should be filtered by an assignment_id.
:: - When there is an answer tag associated with a questionnaire_id, it should be filtered by a questionnaire_id.
:: - When there is an answer tag associated with an user_id, assignment_id, and questionnaire_id, it should be filtered by a user_id, assignment_id, questionnaire_id.
:: - When there is no answer tag associated with a assignment_id, no tag prompts are returned for a assignment_id with no associated answer tags.
:: - When there is no answer tag associated with a questionnaire_id, no tag prompts are returned for a questionnaire_id with no associated answer tags.
:: - When provided with both assignment_id and questionnaire_id, it should provide the correct filtered response.
:: - When provided with one incorrect and one correct param, then no records should be returned.
: * When there are multiple tags are present for an assignment, all related tags should be returned.
: * When a user request is made, it should return records related to current user only.

: Edge Cases:

: * When user_id is undefined, an empty list of tags prompts should be returned.
: * When assignment_id is undefined, an empty list of tags prompts should be returned.
: * When questionnaire_id is undefined, an empty list of tags prompts should be returned.
: * When an unauthorized user tries to access the #index, the user should be returned to root_page.
: * When an invalid parameter is passed, the system should not break and should return valid results.
: * When there are large number of answer tags, the tags are handled properly.

''create_edit'' : Allows the creation or updating of an answer tag for the current student.

: Use Cases:

:: - When a valid combination of answer_id, tag_prompt_deployment_id, and value is provided by a student and no existing tag exists, a new AnswerTag is created.
:: - When a student accesses an existing tag, the tag is updated with the new provided value.
:: - When a student provides a user_id in the parameters, the controller still uses the current_user to ensure tags are associated only with the logged-in student.
:: - When create_edit is called multiple times with the same parameters, it does not create duplicate AnswerTag records — the existing one is updated.

: Edge Cases:
:: - When no answer_id is provided, the system raises an error and does not create or update the tag.
:: - When no tag_prompt_deployment_id is provided, the system raises an error.
:: - When no value is provided, the tag creation/update is rejected with an error.
:: - When incorrect or unexpected user_id is passed, it is ignored, and the tag is created for the current_user.

===Tag Prompt Deployment Controller===
The controller [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/app/models/tag_prompt_deployment.rb] is used by an instructor to view the tagging summary of the users that completed the answer tagging. It also indicates that comments are to be tagged for the characteristic specified by the tag prompt.
=====Methods=====
''tag_prompt'' : Tests that the tag prompt associated with the provided tag_prompt_id is correctly returned by the tag_dep.tag_prompt method.

: Use Cases:
: * When given a valid tag_prompt_id, it should return the associated tag prompt with the deployment.

: Edge Cases:
: * When given an invalid tag_prompt_id, it should not return a tag prompt with the deployment.

''get_number_of_taggable_answers'' : Calculates total taggable answers assigned for a user who participated in ``tag review assignment.''

: Use Cases:
: * When user_id is nil, it should return an error message.
: * When answer_length_threshold is null, it should return a count of tangible answers.
: * When answer_length_threshold is not null, it should return a count of taggable answers less than answers_one.

: Edge Cases:
: * When there are no responses, it should return zero as the count of taggable answers.
: * When questions are empty, it should return count of taggable answers as zero.

''assignment_tagging_progress'' : Accesses the percentage progress of answer tagging.

: Use Cases:
: * When there is a team, a question, and the assignment's rubrics do not vary by round, it should calculate the tagging progress for each user.
: * When there is a team, a question, and the assignment's rubrics do vary by round, it should calculate the tagging progress for each user considering all tagged items.

: Edge Cases:
: * When no questions are found, it should return an empty list.
: * When there are no teams or questions, it should return an empty list.

==Testing Details==
====Demo Videos====
# [https://drive.google.com/file/d/1UTeJC7oc8pbWZeOuCZt3JcdfW5uDv3Fu/view?usp=drive_link Demo Video for Tag Prompt Deployment Controller]

====Using RSpec====

We implemented tests in [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/controllers/answer_tags_controller_spec.rb answer_tags_controller_spec.rb] and [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/models/tag_prompt_deployment_spec.rb tag_prompt_deployment_spec.rb].

=====How to See Test Coverage=====
# Run RSpec for [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/controllers/answer_tags_controller_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

# Run RSpec for [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/models/tag_prompt_deployment_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

==Results==
Both files are 100% covered and additional testing was added to ensure a solid groundwork.

====answer_tags_controller_spec.rb====

: Coverage: 100%
: Hits/line: 63.1

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

====tag_prompt_deployment_spec.rb====

: Coverage: 100%
: Hits/line: 5.2

[[File:Tag_prompt_deployment_coverage_2025.png]]

==Future Work==
1. Modify base files
a. correct several method names (ex: not named after a verb (assignment_tagging_progress))
b. make tag_prompt_deployment.rb more readable and better commented
c. Break some methods down into smaller ones for better functionality (assignment_tagging_progress)

==References==
# [https://github.com/expertiza/expertiza Expertiza GitHub]
# [https://github.com/Michael-Anderson-NCSU/expertiza Project Repository]
# [https://github.com/expertiza/expertiza/pull/2936 Pull Request]
# [https://www.theodinproject.com/lessons/ruby-introduction-to-rspec RSpec]

CSC/ECE 517 Spring 2025 - E2505. Testing Answer Tagging

2025-03-24T17:02:53Z

Mwander5: /* Using RSpec */

==E2505. Testing - Answer Tagging==

This wiki page is for the description of changes made in Spring 2025, CSC/ECE 517 for the E2505 Testing - Testing Answer Tagging.

__TOC__

==Expertiza==
In accordance with the [http://rubyonrails.org/ Ruby on Rails] framework, [http://expertiza.ncsu.edu/ Expertiza] is an open source software project (OSS) led by [https://www.csc.ncsu.edu/people/efg Dr. Edward Gehringer]. Through this platform, the instructor can add and edit assignments that students are able to view and contribute to. There are various filtering methods that streamline this process. There is also the ability for students to peer review other students to give contributing feedback.

==Objective==
Our objective is to test two files which are part of this process. We are testing a controller for answer tags DESCRIBE ANSWER TAGS HERE EDIT ME. As well as a model for tag prompt deployment which interfaces with this answer tags controller which has methods that return various information about a students progress in tagging answers.

==Controller and Spec Files==
Answer Tags
* [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/answer_tags_controller.rb answer_tags_controller.rb] with initial coverage of 0%
* [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/controllers/answer_tags_controller_spec.rb answer_tags_controller_spec.rb]

Tag Prompt Deployment
* [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/tag_prompts_controller.rb tag_prompt_deployment.rb] with initial coverage of 17.65%
* [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/models/tag_prompt_deployment_spec.rb tag_prompt_deployment_spec.rb]

==Testing Implementation==
===Answer Tags Controller===
This controller [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/app/controllers/answer_tags_controller.rb] creates/edits answer tags and tracks the number of tags a student has completed overall per assignment or questionnaire. The controller filters based on assignment_id, questionnaire_id and user_id to present appropriate records. The controllers' output is a JSON-formatted collection of response tags.

=====Methods=====
''action_allowed?'' : Determines whether the current user is permitted to access the given action (index or create_edit) based on their role.

: Use Cases:

:: - When it is a student session, access to index should be allowed.
:: - When it is a student session, access to create_edit should be allowed.
:: - When the session user is a student, access to unsupported actions like destroy or show should be denied.

: Edge Cases:

:: - When the session is not defined, access to any action (e.g., index, create_edit) should be denied.
:: - When a user with no role assigned tries to access index or create_edit, access should be denied.
:: - When an Instructor tries to access an unsupported action (e.g., destroy), access should be denied.
:: - When the action parameter is missing or unrecognized, access should be denied regardless of user role.

''index'' : Returns all the tag prompt deployments in JSON format

: Use Cases:

: * For any authenticated user above student access:
:: - When anyone above student privilege is authorized
:: - When there are no tag prompts deployed, a empty list should be displayed.
:: - When there is 1 tag prompt deployed, 1 should be displayed.
:: - When there are tag prompts deployed with no associated assignment answer tag, tag prompts should not be displayed.
:: - When there is an answer tag associated with an user_id, it should be filtered by an user_id.
:: - When there is an answer tag associated with an assignment_id, it should be filtered by an assignment_id.
:: - When there is an answer tag associated with a questionnaire_id, it should be filtered by a questionnaire_id.
:: - When there is an answer tag associated with an user_id, assignment_id, and questionnaire_id, it should be filtered by a user_id, assignment_id, questionnaire_id.
:: - When there is no answer tag associated with a assignment_id, no tag prompts are returned for a assignment_id with no associated answer tags.
:: - When there is no answer tag associated with a questionnaire_id, no tag prompts are returned for a questionnaire_id with no associated answer tags.
:: - When provided with both assignment_id and questionnaire_id, it should provide the correct filtered response.
:: - When provided with one incorrect and one correct param, then no records should be returned.
: * When there are multiple tags are present for an assignment, all related tags should be returned.
: * When a user request is made, it should return records related to current user only.

: Edge Cases:

: * When user_id is undefined, an empty list of tags prompts should be returned.
: * When assignment_id is undefined, an empty list of tags prompts should be returned.
: * When questionnaire_id is undefined, an empty list of tags prompts should be returned.
: * When an unauthorized user tries to access the #index, the user should be returned to root_page.
: * When an invalid parameter is passed, the system should not break and should return valid results.
: * When there are large number of answer tags, the tags are handled properly.

''create_edit'' : Allows the creation or updating of an answer tag for the current student.

: Use Cases:

:: - When a valid combination of answer_id, tag_prompt_deployment_id, and value is provided by a student and no existing tag exists, a new AnswerTag is created.
:: - When a student accesses an existing tag, the tag is updated with the new provided value.
:: - When a student provides a user_id in the parameters, the controller still uses the current_user to ensure tags are associated only with the logged-in student.
:: - When create_edit is called multiple times with the same parameters, it does not create duplicate AnswerTag records — the existing one is updated.

: Edge Cases:
:: - When no answer_id is provided, the system raises an error and does not create or update the tag.
:: - When no tag_prompt_deployment_id is provided, the system raises an error.
:: - When no value is provided, the tag creation/update is rejected with an error.
:: - When incorrect or unexpected user_id is passed, it is ignored, and the tag is created for the current_user.

===Tag Prompt Deployment Controller===
The controller [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/app/models/tag_prompt_deployment.rb] is used by an instructor to view the tagging summary of the users that completed the answer tagging. It also indicates that comments are to be tagged for the characteristic specified by the tag prompt.
=====Methods=====
''tag_prompt'' : Tests that the tag prompt associated with the provided tag_prompt_id is correctly returned by the tag_dep.tag_prompt method.

: Use Cases:
: * When given a valid tag_prompt_id, it should return the associated tag prompt with the deployment.

: Edge Cases:
: * When given an invalid tag_prompt_id, it should not return a tag prompt with the deployment.

''get_number_of_taggable_answers'' : Calculates total taggable answers assigned for a user who participated in ``tag review assignment.''

: Use Cases:
: * When user_id is nil, it should return an error message.
: * When answer_length_threshold is null, it should return a count of tangible answers.
: * When answer_length_threshold is not null, it should return a count of taggable answers less than answers_one.

: Edge Cases:
: * When there are no responses, it should return zero as the count of taggable answers.
: * When questions are empty, it should return count of taggable answers as zero.

''assignment_tagging_progress'' : Accesses the percentage progress of answer tagging.

: Use Cases:
: * When there is a team, a question, and the assignment's rubrics do not vary by round, it should calculate the tagging progress for each user.
: * When there is a team, a question, and the assignment's rubrics do vary by round, it should calculate the tagging progress for each user considering all tagged items.

: Edge Cases:
: * When no questions are found, it should return an empty list.
: * When there are no teams or questions, it should return an empty list.

==Testing Details==
====Demo Videos====
# [https://drive.google.com/file/d/1UTeJC7oc8pbWZeOuCZt3JcdfW5uDv3Fu/view?usp=drive_link Demo Video for Tag Prompt Deployment Controller]

====Using RSpec====

We implemented tests in [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/controllers/answer_tags_controller_spec.rb answer_tags_controller_spec.rb] and [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/models/tag_prompt_deployment_spec.rb tag_prompt_deployment_spec.rb].

=====How to See Test Coverage=====
# Run RSpec for [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/controllers/answer_tags_controller_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

# Run RSpec for [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/models/tag_prompt_deployment_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

==Results==
Both files are 100% covered and additional testing was added to ensure a solid groundwork.

====answer_tags_controller_spec.rb====

: Coverage: 100%
: Hits/line: 63.1

[[File:Answer_tags_controller_coverage_2505.png]]

====tag_prompt_deployment_spec.rb====

: Coverage: 100%
: Hits/line: 5.2

[[File:Tag_prompt_deployment_coverage_2025.png]]

==Future Work==
1. Modify base files
a. correct several method names (ex: not named after a verb (assignment_tagging_progress))
b. make tag_prompt_deployment.rb more readable and better commented
c. Break some methods down into smaller ones for better functionality (assignment_tagging_progress)

==References==
# [https://github.com/expertiza/expertiza Expertiza GitHub]
# [https://github.com/Michael-Anderson-NCSU/expertiza Project Repository]
# [https://github.com/expertiza/expertiza/pull/2936 Pull Request]
# [https://www.theodinproject.com/lessons/ruby-introduction-to-rspec RSpec]

CSC/ECE 517 Spring 2025 - E2505. Testing Answer Tagging

2025-03-24T01:17:41Z

Mwander5: /* Testing Details */

==E2413. Testing - Answer Tagging==

This wiki page is for the description of changes made in Spring 2025, CSC/ECE 517 for the E2505 Testing - Testing Answer Tagging.

__TOC__

==Expertiza==
In accordance with the [http://rubyonrails.org/ Ruby on Rails] framework, [http://expertiza.ncsu.edu/ Expertiza] is an open source software project (OSS) led by [https://www.csc.ncsu.edu/people/efg Dr. Edward Gehringer]. Through this platform, the instructor can add and edit assignments that students are able to view and contribute to. There are various filtering methods that streamline this process. There is also the ability for students to peer review other students to give contributing feedback.

==Objective==
Our objective is to test two files which are part of this process. We are testing a controller for answer tags DESCRIBE ANSWER TAGS HERE EDIT ME. As well as a model for tag prompt deployment which interfaces with this answer tags controller which has methods that return various information about a students progress in tagging answers.

==Controller and Spec Files==
Answer Tags
* [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/answer_tags_controller.rb answer_tags_controller.rb] with initial coverage of 0%
* [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/controllers/answer_tags_controller_spec.rb answer_tags_controller_spec.rb]

Tag Prompt Deployment
* [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/tag_prompts_controller.rb tag_prompt_deployment.rb] with initial coverage of 17.65%
* [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/models/tag_prompt_deployment_spec.rb tag_prompt_deployment_spec.rb]

==Testing Implementation==
===Answer Tags Controller===
This controller [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/app/controllers/answer_tags_controller.rb] creates/edits answer tags and tracks the number of tags a student has completed overall per assignment or questionnaire. The controller filters based on assignment_id, questionnaire_id and user_id to present appropriate records. The controllers' output is a JSON-formatted collection of response tags.

=====Methods=====
''action_allowed?'' : Determines whether the current user is permitted to access the given action (index or create_edit) based on their role.

: Use Cases:

:: - When it is a student session, access to index should be allowed.
:: - When it is a student session, access to create_edit should be allowed.
:: - When the session user is a student, access to unsupported actions like destroy or show should be denied.

: Edge Cases:

:: - When the session is not defined, access to any action (e.g., index, create_edit) should be denied.
:: - When a user with no role assigned tries to access index or create_edit, access should be denied.
:: - When an Instructor tries to access an unsupported action (e.g., destroy), access should be denied.
:: - When the action parameter is missing or unrecognized, access should be denied regardless of user role.

''index'' : Returns all the tag prompt deployments in JSON format

: Use Cases:

: * For any authenticated user above student access:
:: - When anyone above student privilege is authorized
:: - When there are no tag prompts deployed, a empty list should be displayed.
:: - When there is 1 tag prompt deployed, 1 should be displayed.
:: - When there are tag prompts deployed with no associated assignment answer tag, tag prompts should not be displayed.
:: - When there is an answer tag associated with an user_id, it should be filtered by an user_id.
:: - When there is an answer tag associated with an assignment_id, it should be filtered by an assignment_id.
:: - When there is an answer tag associated with a questionnaire_id, it should be filtered by a questionnaire_id.
:: - When there is an answer tag associated with an user_id, assignment_id, and questionnaire_id, it should be filtered by a user_id, assignment_id, questionnaire_id.
:: - When there is no answer tag associated with a assignment_id, no tag prompts are returned for a assignment_id with no associated answer tags.
:: - When there is no answer tag associated with a questionnaire_id, no tag prompts are returned for a questionnaire_id with no associated answer tags.
:: - When provided with both assignment_id and questionnaire_id, it should provide the correct filtered response.
:: - When provided with one incorrect and one correct param, then no records should be returned.
: * When there are multiple tags are present for an assignment, all related tags should be returned.
: * When a user request is made, it should return records related to current user only.

: Edge Cases:

: * When user_id is undefined, an empty list of tags prompts should be returned.
: * When assignment_id is undefined, an empty list of tags prompts should be returned.
: * When questionnaire_id is undefined, an empty list of tags prompts should be returned.
: * When an unauthorized user tries to access the #index, the user should be returned to root_page.
: * When an invalid parameter is passed, the system should not break and should return valid results.
: * When there are large number of answer tags, the tags are handled properly.

''create_edit'' : Allows the creation or updating of an answer tag for the current student.

: Use Cases:

:: - When a valid combination of answer_id, tag_prompt_deployment_id, and value is provided by a student and no existing tag exists, a new AnswerTag is created.
:: - When a student accesses an existing tag, the tag is updated with the new provided value.
:: - When a student provides a user_id in the parameters, the controller still uses the current_user to ensure tags are associated only with the logged-in student.
:: - When create_edit is called multiple times with the same parameters, it does not create duplicate AnswerTag records — the existing one is updated.

: Edge Cases:
:: - When no answer_id is provided, the system raises an error and does not create or update the tag.
:: - When no tag_prompt_deployment_id is provided, the system raises an error.
:: - When no value is provided, the tag creation/update is rejected with an error.
:: - When incorrect or unexpected user_id is passed, it is ignored, and the tag is created for the current_user.

===Tag Prompt Deployment Controller===
The controller [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/app/models/tag_prompt_deployment.rb] is used by an instructor to view the tagging summary of the users that completed the answer tagging. It also indicates that comments are to be tagged for the characteristic specified by the tag prompt.
=====Methods=====
''tag_prompt'' : Tests that the tag prompt associated with the provided tag_prompt_id is correctly returned by the tag_dep.tag_prompt method.

: Use Cases:
: * When given a valid tag_prompt_id, it should return the associated tag prompt with the deployment.

: Edge Cases:
: * When given an invalid tag_prompt_id, it should not return a tag prompt with the deployment.

''get_number_of_taggable_answers'' : Calculates total taggable answers assigned for a user who participated in ``tag review assignment.''

: Use Cases:
: * When user_id is nil, it should return an error message.
: * When answer_length_threshold is null, it should return a count of tangible answers.
: * When answer_length_threshold is not null, it should return a count of taggable answers less than answers_one.

: Edge Cases:
: * When there are no responses, it should return zero as the count of taggable answers.
: * When questions are empty, it should return count of taggable answers as zero.

''assignment_tagging_progress'' : Accesses the percentage progress of answer tagging.

: Use Cases:
: * When there is a team, a question, and the assignment's rubrics do not vary by round, it should calculate the tagging progress for each user.
: * When there is a team, a question, and the assignment's rubrics do vary by round, it should calculate the tagging progress for each user considering all tagged items.

: Edge Cases:
: * When no questions are found, it should return an empty list.
: * When there are no teams or questions, it should return an empty list.

==Testing Details==
====Demo Videos====
# [https://drive.google.com/file/d/1UTeJC7oc8pbWZeOuCZt3JcdfW5uDv3Fu/view?usp=drive_link Demo Video for Tag Prompt Deployment Controller]

====Using RSpec====

We implemented tests in [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/controllers/answer_tags_controller_spec.rb] and [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/models/tag_prompt_deployment_spec.rb].

=====How to See Test Coverage=====
# Run RSpec for [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/controllers/answer_tags_controller_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

# Run RSpec for [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/models/tag_prompt_deployment_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

==Results==
Both files are 100% covered and additional testing was added to ensure a solid groundwork.

====answer_tags_controller_spec.rb====

: Coverage: 100%
: Hits/line: 63.1

[[File:Answer_tags_controller_coverage_2505.png]]

====tag_prompt_deployment_spec.rb====

: Coverage: 100%
: Hits/line: 5.2

[[File:Tag_prompt_deployment_coverage_2025.png]]

==Future Work==
1. Modify base files
a. correct several method names (ex: not named after a verb (assignment_tagging_progress))
b. make tag_prompt_deployment.rb more readable and better commented
c. Break some methods down into smaller ones for better functionality (assignment_tagging_progress)

==References==
# [https://github.com/expertiza/expertiza Expertiza GitHub]
# [https://github.com/Michael-Anderson-NCSU/expertiza Project Repository]
# [https://github.com/expertiza/expertiza/pull/2936 Pull Request]
# [https://www.theodinproject.com/lessons/ruby-introduction-to-rspec RSpec]

CSC/ECE 517 Spring 2025 - E2505. Testing Answer Tagging

2025-03-24T01:06:06Z

Mwander5: /* References */

==E2413. Testing - Answer Tagging==

This wiki page is for the description of changes made in Spring 2025, CSC/ECE 517 for the E2505 Testing - Testing Answer Tagging.

__TOC__

==Expertiza==
In accordance with the [http://rubyonrails.org/ Ruby on Rails] framework, [http://expertiza.ncsu.edu/ Expertiza] is an open source software project (OSS) led by [https://www.csc.ncsu.edu/people/efg Dr. Edward Gehringer]. Through this platform, the instructor can add and edit assignments that students are able to view and contribute to. There are various filtering methods that streamline this process. There is also the ability for students to peer review other students to give contributing feedback.

==Objective==
Our objective is to test two files which are part of this process. We are testing a controller for answer tags DESCRIBE ANSWER TAGS HERE EDIT ME. As well as a model for tag prompt deployment which interfaces with this answer tags controller which has methods that return various information about a students progress in tagging answers.

==Controller and Spec Files==
Answer Tags
* [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/answer_tags_controller.rb answer_tags_controller.rb] with initial coverage of 0%
* [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/controllers/answer_tags_controller_spec.rb answer_tags_controller_spec.rb]

Tag Prompt Deployment
* [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/tag_prompts_controller.rb tag_prompt_deployment.rb] with initial coverage of 17.65%
* [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/models/tag_prompt_deployment_spec.rb tag_prompt_deployment_spec.rb]

==Testing Implementation==
===Answer Tags Controller===
This controller [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/app/controllers/answer_tags_controller.rb] creates/edits answer tags and tracks the number of tags a student has completed overall per assignment or questionnaire. The controller filters based on assignment_id, questionnaire_id and user_id to present appropriate records. The controllers' output is a JSON-formatted collection of response tags.

=====Methods=====
''action_allowed?'' : Determines whether the current user is permitted to access the given action (index or create_edit) based on their role.

: Use Cases:

:: - When it is a student session, access to index should be allowed.
:: - When it is a student session, access to create_edit should be allowed.
:: - When the session user is a student, access to unsupported actions like destroy or show should be denied.

: Edge Cases:

:: - When the session is not defined, access to any action (e.g., index, create_edit) should be denied.
:: - When a user with no role assigned tries to access index or create_edit, access should be denied.
:: - When an Instructor tries to access an unsupported action (e.g., destroy), access should be denied.
:: - When the action parameter is missing or unrecognized, access should be denied regardless of user role.

''index'' : Returns all the tag prompt deployments in JSON format

: Use Cases:

: * For any authenticated user above student access:
:: - When anyone above student privilege is authorized
:: - When there are no tag prompts deployed, a empty list should be displayed.
:: - When there is 1 tag prompt deployed, 1 should be displayed.
:: - When there are tag prompts deployed with no associated assignment answer tag, tag prompts should not be displayed.
:: - When there is an answer tag associated with an user_id, it should be filtered by an user_id.
:: - When there is an answer tag associated with an assignment_id, it should be filtered by an assignment_id.
:: - When there is an answer tag associated with a questionnaire_id, it should be filtered by a questionnaire_id.
:: - When there is an answer tag associated with an user_id, assignment_id, and questionnaire_id, it should be filtered by a user_id, assignment_id, questionnaire_id.
:: - When there is no answer tag associated with a assignment_id, no tag prompts are returned for a assignment_id with no associated answer tags.
:: - When there is no answer tag associated with a questionnaire_id, no tag prompts are returned for a questionnaire_id with no associated answer tags.
:: - When provided with both assignment_id and questionnaire_id, it should provide the correct filtered response.
:: - When provided with one incorrect and one correct param, then no records should be returned.
: * When there are multiple tags are present for an assignment, all related tags should be returned.
: * When a user request is made, it should return records related to current user only.

: Edge Cases:

: * When user_id is undefined, an empty list of tags prompts should be returned.
: * When assignment_id is undefined, an empty list of tags prompts should be returned.
: * When questionnaire_id is undefined, an empty list of tags prompts should be returned.
: * When an unauthorized user tries to access the #index, the user should be returned to root_page.
: * When an invalid parameter is passed, the system should not break and should return valid results.
: * When there are large number of answer tags, the tags are handled properly.

''create_edit'' : Allows the creation or updating of an answer tag for the current student.

: Use Cases:

:: - When a valid combination of answer_id, tag_prompt_deployment_id, and value is provided by a student and no existing tag exists, a new AnswerTag is created.
:: - When a student accesses an existing tag, the tag is updated with the new provided value.
:: - When a student provides a user_id in the parameters, the controller still uses the current_user to ensure tags are associated only with the logged-in student.
:: - When create_edit is called multiple times with the same parameters, it does not create duplicate AnswerTag records — the existing one is updated.

: Edge Cases:
:: - When no answer_id is provided, the system raises an error and does not create or update the tag.
:: - When no tag_prompt_deployment_id is provided, the system raises an error.
:: - When no value is provided, the tag creation/update is rejected with an error.
:: - When incorrect or unexpected user_id is passed, it is ignored, and the tag is created for the current_user.

===Tag Prompt Deployment Controller===
The controller [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/app/models/tag_prompt_deployment.rb] is used by an instructor to view the tagging summary of the users that completed the answer tagging. It also indicates that comments are to be tagged for the characteristic specified by the tag prompt.
=====Methods=====
''tag_prompt'' : Tests that the tag prompt associated with the provided tag_prompt_id is correctly returned by the tag_dep.tag_prompt method.

: Use Cases:
: * When given a valid tag_prompt_id, it should return the associated tag prompt with the deployment.

: Edge Cases:
: * When given an invalid tag_prompt_id, it should not return a tag prompt with the deployment.

''get_number_of_taggable_answers'' : Calculates total taggable answers assigned for a user who participated in ``tag review assignment.''

: Use Cases:
: * When user_id is nil, it should return an error message.
: * When answer_length_threshold is null, it should return a count of tangible answers.
: * When answer_length_threshold is not null, it should return a count of taggable answers less than answers_one.

: Edge Cases:
: * When there are no responses, it should return zero as the count of taggable answers.
: * When questions are empty, it should return count of taggable answers as zero.

''assignment_tagging_progress'' : Accesses the percentage progress of answer tagging.

: Use Cases:
: * When there is a team, a question, and the assignment's rubrics do not vary by round, it should calculate the tagging progress for each user.
: * When there is a team, a question, and the assignment's rubrics do vary by round, it should calculate the tagging progress for each user considering all tagged items.

: Edge Cases:
: * When no questions are found, it should return an empty list.
: * When there are no teams or questions, it should return an empty list.

==Testing Details==
====Demo Videos====
put demo video here

====Using RSpec====

We implemented tests in [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/controllers/answer_tags_controller_spec.rb] and [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/models/tag_prompt_deployment_spec.rb].

=====How to See Test Coverage=====
# Run RSpec for [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/controllers/answer_tags_controller_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

# Run RSpec for [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/models/tag_prompt_deployment_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

==Results==
Both files are 100% covered and additional testing was added to ensure a solid groundwork.

====answer_tags_controller_spec.rb====

: Coverage: 100%
: Hits/line: 63.1

[[File:Answer_tags_controller_coverage_2505.png]]

====tag_prompt_deployment_spec.rb====

: Coverage: 100%
: Hits/line: 5.2

[[File:Tag_prompt_deployment_coverage_2025.png]]

==Future Work==
1. Modify base files
a. correct several method names (ex: not named after a verb (assignment_tagging_progress))
b. make tag_prompt_deployment.rb more readable and better commented
c. Break some methods down into smaller ones for better functionality (assignment_tagging_progress)

==References==
# [https://github.com/expertiza/expertiza Expertiza GitHub]
# [https://github.com/Michael-Anderson-NCSU/expertiza Project Repository]
# [https://github.com/expertiza/expertiza/pull/2936 Pull Request]
# [https://www.theodinproject.com/lessons/ruby-introduction-to-rspec RSpec]

CSC/ECE 517 Spring 2025 - E2505. Testing Answer Tagging

2025-03-22T18:51:55Z

Mwander5:

==E2413. Testing - Answer Tagging==

This wiki page is for the description of changes made in Spring 2025, CSC/ECE 517 for the E2505 Testing - Testing Answer Tagging.

__TOC__

==Expertiza==
In accordance with the [http://rubyonrails.org/ Ruby on Rails] framework, [http://expertiza.ncsu.edu/ Expertiza] is an open source software project (OSS) led by [https://www.csc.ncsu.edu/people/efg Dr. Edward Gehringer]. Through this platform, the instructor can add and edit assignments that students are able to view and contribute to. There are various filtering methods that streamline this process. There is also the ability for students to peer review other students to give contributing feedback.

==Objective==
Our objective is to test two files which are part of this process. We are testing a controller for answer tags DESCRIBE ANSWER TAGS HERE EDIT ME. As well as a model for tag prompt deployment which interfaces with this answer tags controller which has methods that return various information about a students progress in tagging answers.

==Controller and Spec Files==
Answer Tags
* [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/answer_tags_controller.rb answer_tags_controller.rb] with initial coverage of 0%
* [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/controllers/answer_tags_controller_spec.rb answer_tags_controller_spec.rb]

Tag Prompt Deployment
* [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/tag_prompts_controller.rb tag_prompt_deployment.rb] with initial coverage of 17.65%
* [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/models/tag_prompt_deployment_spec.rb tag_prompt_deployment_spec.rb]

==Testing Implementation==
===Answer Tags Controller===
This controller [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/app/controllers/answer_tags_controller.rb] creates answer tags and tracks the number of tags a student has completed overall per assignment or questionnaire. The controllers' output is a JSON-formatted collection of response tags.

=====Methods=====
''action_allowed?'' : Determines if the user has the permission to see all the tags or create_edit a tag.

: Use Cases:

: * When it is a student session, access to index should be allowed.
: * When it is a student session, access to create_edit should be allowed.
: * When it is a student session, access to destroy should not be allowed.

: Edge Cases:

: * When the session is undefined, access to index should be inaccessible.
: * When the session is undefined, access to create_edit should be inaccessible.
: * When the session is undefined, access to destroy should be inaccessible.

''index'' : Returns all the tag prompt deployments in JSON format

: Use Cases:

: * When there are no tag prompts deployed, a empty list should be displayed.
: * When there is 1 tag prompt deployed, 1 should be displayed.
: * When there are tag prompts deployed with no associated assignment answer tag, tag prompts should not be displayed.
: * When there is an answer tag associated with an user_id, it should be filtered by an user_id.
: * When there is an answer tag associated with an assignment_id, it should be filtered by an assignment_id.
: * When there is an answer tag associated with a questionnaire_id, it should be filtered by a questionnaire_id.
: * When there is an answer tag associated with an user_id, assignment_id, and questionnaire_id, it should be filtered by a user_id, assignment_id, questionnaire_id.
: * When there is no answer tag associated with a assignment_id, no tag prompts are returned for a assignment_id with no associated answer tags.
: * When there is no answer tag associated with a questionnaire_id, no tag prompts are returned for a questionnaire_id with no associated answer tags.

: Edge Cases:

: * When user_id is undefined, an empty list of tags prompts should be returned.
: * When assignment_id is undefined, an empty list of tags prompts should be returned.
: * When questionnaire_id is undefined, an empty list of tags prompts should be returned.

''create_edit'' : Allow the creation or updating of an answer tag.

: Use Cases:

: * When a current tag is accessed, the current tag should be updated with new provided values.
: * When a current tag is accessed by a student, the current tag should not be updated with new values.

: Edge Cases:
: * When no mapping is found related to any tag_prompt_deployment for that tag (foreign key constraint), an empty list of tags prompts should be returned.

===Tag Prompt Deployment Controller===
The controller [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/app/models/tag_prompt_deployment.rb] is used by an instructor to view the tagging summary of the users that completed the answer tagging. It also indicates that comments are to be tagged for the characteristic specified by the tag prompt.
=====Methods=====
''tag_prompt'' : Tests that the tag prompt associated with the provided tag_prompt_id is correctly returned by the tag_dep.tag_prompt method.

: Use Cases:
: * When given a valid tag_prompt_id, it should return the associated tag prompt with the deployment.

: Edge Cases:
: * When given an invalid tag_prompt_id, it should not return a tag prompt with the deployment.

''get_number_of_taggable_answers'' : Calculates total taggable answers assigned for a user who participated in ``tag review assignment.''

: Use Cases:
: * When user_id is nil, it should return an error message.
: * When answer_length_threshold is null, it should return a count of tangible answers.
: * When answer_length_threshold is not null, it should return a count of taggable answers less than answers_one.

: Edge Cases:
: * When there are no responses, it should return zero as the count of taggable answers.
: * When questions are empty, it should return count of taggable answers as zero.

''assignment_tagging_progress'' : Accesses the percentage progress of answer tagging.

: Use Cases:
: * When there is a team, a question, and the assignment's rubrics do not vary by round, it should calculate the tagging progress for each user.
: * When there is a team, a question, and the assignment's rubrics do vary by round, it should calculate the tagging progress for each user considering all tagged items.

: Edge Cases:
: * When no questions are found, it should return an empty list.
: * When there are no teams or questions, it should return an empty list.

==Testing Details==
====Demo Videos====
put demo video here

====Using RSpec====

We implemented tests in [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/controllers/answer_tags_controller_spec.rb] and [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/models/tag_prompt_deployment_spec.rb].

=====How to See Test Coverage=====
# Run RSpec for [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/controllers/answer_tags_controller_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

# Run RSpec for [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/models/tag_prompt_deployment_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

==Results==
Both files are 100% covered and additional testing was added to ensure a solid groundwork.

==Future Work==
1. Modify base files
a. correct several method names (ex: not named after a verb (assignment_tagging_progress))
b. make tag_prompt_deployment.rb more readable and better commented
c. Break some methods down into smaller ones for better functionality (assignment_tagging_progress)

==References==
# [https://github.com/expertiza/expertiza Expertiza GitHub]
# [https://github.com/CSC517-Project3/expertiza Project Repository]
# [https://github.com/orgs/CSC517-Project3/projects/1/views/1 Github Project Board]
# [https://github.com/expertiza/expertiza/pull/2775 Pull Request]
# [https://www.theodinproject.com/lessons/ruby-introduction-to-rspec RSpec]

CSC/ECE 517 Spring 2025 - E2505. Testing Answer Tagging

2025-03-22T18:47:47Z

Mwander5:

==E2413. Testing - Answer Tagging==

This wiki page is for the description of changes made in Spring 2025, CSC/ECE 517 for the E2505 Testing - Testing Answer Tagging.

__TOC__

==Expertiza==
In accordance with the [http://rubyonrails.org/ Ruby on Rails] framework, [http://expertiza.ncsu.edu/ Expertiza] is an open source software project (OSS) led by [https://www.csc.ncsu.edu/people/efg Dr. Edward Gehringer]. Through this platform, the instructor can add and edit assignments that students are able to view and contribute to. There are various filtering methods that streamline this process. There is also the ability for students to peer review other students to give contributing feedback.

==Objective==
Our objective is to test two files which are part of this process. We are testing a controller for answer tags DESCRIBE ANSWER TAGS HERE EDIT ME. As well as a model for tag prompt deployment which interfaces with this answer tags controller which has methods that return various information about a students progress in tagging answers.

==Controller and Spec Files==
Answer Tags
* [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/answer_tags_controller.rb answer_tags_controller.rb] with initial coverage of 0%
* [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/controllers/answer_tags_controller_spec.rb answer_tags_controller_spec.rb]

Tag Prompt Deployment
* [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/tag_prompts_controller.rb tag_prompt_deployment.rb] with initial coverage of 17.65%
* [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/models/tag_prompt_deployment_spec.rb tag_prompt_deployment_spec.rb]

==Testing Implementation==
===Answer Tags Controller===
This controller [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/app/controllers/answer_tags_controller.rb] creates answer tags and tracks the number of tags a student has completed overall per assignment or questionnaire. The controllers' output is a JSON-formatted collection of response tags.

=====Methods=====
''action_allowed?'' : Determines if the user has the permission to see all the tags or create_edit a tag.

: Use Cases:

: * When it is a student session, access to index should be allowed.
: * When it is a student session, access to create_edit should be allowed.
: * When it is a student session, access to destroy should not be allowed.

: Edge Cases:

: * When the session is undefined, access to index should be inaccessible.
: * When the session is undefined, access to create_edit should be inaccessible.
: * When the session is undefined, access to destroy should be inaccessible.

''index'' : Returns all the tag prompt deployments in JSON format

: Use Cases:

: * When there are no tag prompts deployed, a empty list should be displayed.
: * When there is 1 tag prompt deployed, 1 should be displayed.
: * When there are tag prompts deployed with no associated assignment answer tag, tag prompts should not be displayed.
: * When there is an answer tag associated with an user_id, it should be filtered by an user_id.
: * When there is an answer tag associated with an assignment_id, it should be filtered by an assignment_id.
: * When there is an answer tag associated with a questionnaire_id, it should be filtered by a questionnaire_id.
: * When there is an answer tag associated with an user_id, assignment_id, and questionnaire_id, it should be filtered by a user_id, assignment_id, questionnaire_id.
: * When there is no answer tag associated with a assignment_id, no tag prompts are returned for a assignment_id with no associated answer tags.
: * When there is no answer tag associated with a questionnaire_id, no tag prompts are returned for a questionnaire_id with no associated answer tags.

: Edge Cases:

: * When user_id is undefined, an empty list of tags prompts should be returned.
: * When assignment_id is undefined, an empty list of tags prompts should be returned.
: * When questionnaire_id is undefined, an empty list of tags prompts should be returned.

''create_edit'' : Allow the creation or updating of an answer tag.

: Use Cases:

: * When a current tag is accessed, the current tag should be updated with new provided values.
: * When a current tag is accessed by a student, the current tag should not be updated with new values.

: Edge Cases:
: * When no mapping is found related to any tag_prompt_deployment for that tag (foreign key constraint), an empty list of tags prompts should be returned.

===Tag Prompt Deployment Controller===
The controller [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/app/models/tag_prompt_deployment.rb] is used by an instructor to view the tagging summary of the users that completed the answer tagging. It also indicates that comments are to be tagged for the characteristic specified by the tag prompt.
=====Methods=====
''tag_prompt'' : Tests that the tag prompt associated with the provided tag_prompt_id is correctly returned by the tag_dep.tag_prompt method.

: Use Cases:
: * When given a valid tag_prompt_id, it should return the associated tag prompt with the deployment.

: Edge Cases:
: * When given an invalid tag_prompt_id, it should not return a tag prompt with the deployment.

''get_number_of_taggable_answers'' : Calculates total taggable answers assigned for a user who participated in ``tag review assignment.''

: Use Cases:
: * When user_id is nil, it should return an error message.
: * When answer_length_threshold is null, it should return a count of tangible answers.
: * When answer_length_threshold is not null, it should return a count of taggable answers less than answers_one.

: Edge Cases:
: * When there are no responses, it should return zero as the count of taggable answers.
: * When questions are empty, it should return count of taggable answers as zero.

''assignment_tagging_progress'' : Accesses the percentage progress of answer tagging.

: Use Cases:
: * When there is a team, a question, and the assignment's rubrics do not vary by round, it should calculate the tagging progress for each user.
: * When there is a team, a question, and the assignment's rubrics do vary by round, it should calculate the tagging progress for each user considering all tagged items.

: Edge Cases:
: * When no questions are found, it should return an empty list.
: * When there are no teams or questions, it should return an empty list.

==Testing Details==
====Demo Videos====
put demo video here

====Using RSpec====

We implemented tests in [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/controllers/answer_tags_controller_spec.rb] and [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/models/tag_prompt_deployment_spec.rb].

=====How to See Test Coverage=====
# Run RSpec for [https://github.com/Michael-Anderson-NCSU/expertiza/blob/main/spec/controllers/answer_tags_controller_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

# Run RSpec for [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/models/tag_prompt_deployment_spec.rb tag_prompt_deployment_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

==Results==
results section

==Future Work==
1. future work description

==References==
# [https://github.com/expertiza/expertiza Expertiza GitHub]
# [https://github.com/CSC517-Project3/expertiza Project Repository]
# [https://github.com/orgs/CSC517-Project3/projects/1/views/1 Github Project Board]
# [https://github.com/expertiza/expertiza/pull/2775 Pull Request]
# [https://www.theodinproject.com/lessons/ruby-introduction-to-rspec RSpec]

CSC/ECE 517 Spring 2025 - E2505. Testing Answer Tagging

2025-03-22T18:43:15Z

Mwander5:

==E2413. Testing - Answer Tagging==

This wiki page is for the description of changes made in Spring 2025, CSC/ECE 517 for the E2505 Testing - Testing Answer Tagging.

__TOC__

==Expertiza==
In accordance with the [http://rubyonrails.org/ Ruby on Rails] framework, [http://expertiza.ncsu.edu/ Expertiza] is an open source software project (OSS) led by [https://www.csc.ncsu.edu/people/efg Dr. Edward Gehringer]. Through this platform, the instructor can add and edit assignments that students are able to view and contribute to. There are various filtering methods that streamline this process. There is also the ability for students to peer review other students to give contributing feedback.

==Objective==
Our objective is to test two files which are part of this process. We are testing a controller for answer tags DESCRIBE ANSWER TAGS HERE EDIT ME. As well as a model for tag prompt deployment which interfaces with this answer tags controller which has methods that return various information about a students progress in tagging answers.

==Controller and Spec Files==
Answer Tags
* [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/answer_tags_controller.rb answer_tags_controller.rb] with initial coverage of 0%
* [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/controllers/answer_tags_controller_spec.rb answer_tags_controller_spec.rb]

Tag Prompt Deployment
* [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/tag_prompts_controller.rb tag_prompt_deployment.rb] with initial coverage of 17.65%
* [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/models/tag_prompt_deployment_spec.rb tag_prompt_deployment_spec.rb]

==Testing Implementation==
===Answer Tags Controller===
This controller [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/answer_tags_controller.rb answer_tags_controller.rb] creates answer tags and tracks the number of tags a student has completed overall per assignment or questionnaire. The controllers' output is a JSON-formatted collection of response tags.

=====Methods=====
''action_allowed?'' : Determines if the user has the permission to see all the tags or create_edit a tag.

: Use Cases:

: * When it is a student session, access to index should be allowed.
: * When it is a student session, access to create_edit should be allowed.
: * When it is a student session, access to destroy should not be allowed.

: Edge Cases:

: * When the session is undefined, access to index should be inaccessible.
: * When the session is undefined, access to create_edit should be inaccessible.
: * When the session is undefined, access to destroy should be inaccessible.

''index'' : Returns all the tag prompt deployments in JSON format

: Use Cases:

: * When there are no tag prompts deployed, a empty list should be displayed.
: * When there is 1 tag prompt deployed, 1 should be displayed.
: * When there are tag prompts deployed with no associated assignment answer tag, tag prompts should not be displayed.
: * When there is an answer tag associated with an user_id, it should be filtered by an user_id.
: * When there is an answer tag associated with an assignment_id, it should be filtered by an assignment_id.
: * When there is an answer tag associated with a questionnaire_id, it should be filtered by a questionnaire_id.
: * When there is an answer tag associated with an user_id, assignment_id, and questionnaire_id, it should be filtered by a user_id, assignment_id, questionnaire_id.
: * When there is no answer tag associated with a assignment_id, no tag prompts are returned for a assignment_id with no associated answer tags.
: * When there is no answer tag associated with a questionnaire_id, no tag prompts are returned for a questionnaire_id with no associated answer tags.

: Edge Cases:

: * When user_id is undefined, an empty list of tags prompts should be returned.
: * When assignment_id is undefined, an empty list of tags prompts should be returned.
: * When questionnaire_id is undefined, an empty list of tags prompts should be returned.

''create_edit'' : Allow the creation or updating of an answer tag.

: Use Cases:

: * When a current tag is accessed, the current tag should be updated with new provided values.
: * When a current tag is accessed by a student, the current tag should not be updated with new values.

: Edge Cases:
: * When no mapping is found related to any tag_prompt_deployment for that tag (foreign key constraint), an empty list of tags prompts should be returned.

===Tag Prompt Deployment Controller===
The controller [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/tag_prompts_controller.rb tag_prompt_deployment.rb] is used by an instructor to view the tagging summary of the users that completed the answer tagging. It also indicates that comments are to be tagged for the characteristic specified by the tag prompt.
=====Methods=====
''tag_prompt'' : Tests that the tag prompt associated with the provided tag_prompt_id is correctly returned by the tag_dep.tag_prompt method.

: Use Cases:
: * When given a valid tag_prompt_id, it should return the associated tag prompt with the deployment.

: Edge Cases:
: * When given an invalid tag_prompt_id, it should not return a tag prompt with the deployment.

''get_number_of_taggable_answers'' : Calculates total taggable answers assigned for a user who participated in ``tag review assignment.''

: Use Cases:
: * When user_id is nil, it should return an error message.
: * When answer_length_threshold is null, it should return a count of tangible answers.
: * When answer_length_threshold is not null, it should return a count of taggable answers less than answers_one.

: Edge Cases:
: * When there are no responses, it should return zero as the count of taggable answers.
: * When questions are empty, it should return count of taggable answers as zero.

''assignment_tagging_progress'' : Accesses the percentage progress of answer tagging.

: Use Cases:
: * When there is a team, a question, and the assignment's rubrics do not vary by round, it should calculate the tagging progress for each user.
: * When there is a team, a question, and the assignment's rubrics do vary by round, it should calculate the tagging progress for each user considering all tagged items.

: Edge Cases:
: * When no questions are found, it should return an empty list.
: * When there are no teams or questions, it should return an empty list.

==Testing Details==
====Demo Videos====
put demo video here

====Using RSpec====

We implemented tests in [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/controllers/answer_tags_controller_spec.rb answer_tags_controller_spec.rb] and [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/models/tag_prompt_deployment_spec.rb tag_prompt_deployment_spec.rb].

=====How to See Test Coverage=====
# Run RSpec for [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/controllers/answer_tags_controller_spec.rb answer_tags_controller_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

# Run RSpec for [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/models/tag_prompt_deployment_spec.rb tag_prompt_deployment_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

==Results==
results section

==Future Work==
1. future work description

==References==
# [https://github.com/expertiza/expertiza Expertiza GitHub]
# [https://github.com/CSC517-Project3/expertiza Project Repository]
# [https://github.com/orgs/CSC517-Project3/projects/1/views/1 Github Project Board]
# [https://github.com/expertiza/expertiza/pull/2775 Pull Request]
# [https://www.theodinproject.com/lessons/ruby-introduction-to-rspec RSpec]

CSC/ECE 517 Spring 2025 - E2505. Testing Answer Tagging

2025-03-17T23:27:24Z

Mwander5: Created page with "==E2413. Testing - Answer Tagging== This wiki page is for the description of changes made in Spring 2025, CSC/ECE 517 for the E2505 Testing - Testing Answer Tagging. __TOC__ ==Expertiza== Describe expertiza ==Objective== Describe our objective ==Controller and Spec Files== Answer Tags * [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/answer_tags_controller.rb answer_tags_controller.rb] with initial coverage of 0% * [https://github.com/CSC517..."

==E2413. Testing - Answer Tagging==

This wiki page is for the description of changes made in Spring 2025, CSC/ECE 517 for the E2505 Testing - Testing Answer Tagging.

__TOC__

==Expertiza==
Describe expertiza

==Objective==
Describe our objective

==Controller and Spec Files==
Answer Tags
* [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/answer_tags_controller.rb answer_tags_controller.rb] with initial coverage of 0%
* [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/controllers/answer_tags_controller_spec.rb answer_tags_controller_spec.rb]

Tag Prompt Deployment
* [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/tag_prompts_controller.rb tag_prompt_deployment.rb] with initial coverage of 17.65%
* [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/models/tag_prompt_deployment_spec.rb tag_prompt_deployment_spec.rb]

==Testing Implementation==
===Answer Tags Controller===
This controller [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/answer_tags_controller.rb answer_tags_controller.rb] creates answer tags and tracks the number of tags a student has completed overall per assignment or questionnaire. The controllers' output is a JSON-formatted collection of response tags.

=====Methods=====
''action_allowed?'' : Determines if the user has the permission to see all the tags or create_edit a tag.

: Use Cases:

: * When it is a student session, access to index should be allowed.
: * When it is a student session, access to create_edit should be allowed.
: * When it is a student session, access to destroy should not be allowed.

: Edge Cases:

: * When the session is undefined, access to index should be inaccessible.
: * When the session is undefined, access to create_edit should be inaccessible.
: * When the session is undefined, access to destroy should be inaccessible.

''index'' : Returns all the tag prompt deployments in JSON format

: Use Cases:

: * When there are no tag prompts deployed, a empty list should be displayed.
: * When there is 1 tag prompt deployed, 1 should be displayed.
: * When there are tag prompts deployed with no associated assignment answer tag, tag prompts should not be displayed.
: * When there is an answer tag associated with an user_id, it should be filtered by an user_id.
: * When there is an answer tag associated with an assignment_id, it should be filtered by an assignment_id.
: * When there is an answer tag associated with a questionnaire_id, it should be filtered by a questionnaire_id.
: * When there is an answer tag associated with an user_id, assignment_id, and questionnaire_id, it should be filtered by a user_id, assignment_id, questionnaire_id.
: * When there is no answer tag associated with a assignment_id, no tag prompts are returned for a assignment_id with no associated answer tags.
: * When there is no answer tag associated with a questionnaire_id, no tag prompts are returned for a questionnaire_id with no associated answer tags.

: Edge Cases:

: * When user_id is undefined, an empty list of tags prompts should be returned.
: * When assignment_id is undefined, an empty list of tags prompts should be returned.
: * When questionnaire_id is undefined, an empty list of tags prompts should be returned.

''create_edit'' : Allow the creation or updating of an answer tag.

: Use Cases:

: * When a current tag is accessed, the current tag should be updated with new provided values.
: * When a current tag is accessed by a student, the current tag should not be updated with new values.

: Edge Cases:
: * When no mapping is found related to any tag_prompt_deployment for that tag (foreign key constraint), an empty list of tags prompts should be returned.

===Tag Prompt Deployment Controller===
The controller [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/tag_prompts_controller.rb tag_prompt_deployment.rb] is used by an instructor to view the tagging summary of the users that completed the answer tagging. It also indicates that comments are to be tagged for the characteristic specified by the tag prompt.
=====Methods=====
''tag_prompt'' : Tests that the tag prompt associated with the provided tag_prompt_id is correctly returned by the tag_dep.tag_prompt method.

: Use Cases:
: * When given a valid tag_prompt_id, it should return the associated tag prompt with the deployment.

: Edge Cases:
: * When given an invalid tag_prompt_id, it should not return a tag prompt with the deployment.

''get_number_of_taggable_answers'' : Calculates total taggable answers assigned for a user who participated in ``tag review assignment.''

: Use Cases:
: * When user_id is nil, it should return an error message.
: * When answer_length_threshold is null, it should return a count of tangible answers.
: * When answer_length_threshold is not null, it should return a count of taggable answers less than answers_one.

: Edge Cases:
: * When there are no responses, it should return zero as the count of taggable answers.
: * When questions are empty, it should return count of taggable answers as zero.

''assignment_tagging_progress'' : Accesses the percentage progress of answer tagging.

: Use Cases:
: * When there is a team, a question, and the assignment's rubrics do not vary by round, it should calculate the tagging progress for each user.
: * When there is a team, a question, and the assignment's rubrics do vary by round, it should calculate the tagging progress for each user considering all tagged items.

: Edge Cases:
: * When no questions are found, it should return an empty list.
: * When there are no teams or questions, it should return an empty list.

==Testing Details==
====Demo Videos====
put demo video here

====Using RSpec====

We implemented tests in [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/controllers/answer_tags_controller_spec.rb answer_tags_controller_spec.rb] and [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/models/tag_prompt_deployment_spec.rb tag_prompt_deployment_spec.rb].

=====How to See Test Coverage=====
# Run RSpec for [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/controllers/answer_tags_controller_spec.rb answer_tags_controller_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

# Run RSpec for [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/models/tag_prompt_deployment_spec.rb tag_prompt_deployment_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

==Results==
results section

==Future Work==
1. future work description

==References==
# [https://github.com/expertiza/expertiza Expertiza GitHub]
# [https://github.com/CSC517-Project3/expertiza Project Repository]
# [https://github.com/orgs/CSC517-Project3/projects/1/views/1 Github Project Board]
# [https://github.com/expertiza/expertiza/pull/2775 Pull Request]
# [https://www.theodinproject.com/lessons/ruby-introduction-to-rspec RSpec]

CSC/ECE 517 Spring 2025

2025-03-17T23:26:22Z

Mwander5:

* [[CSC/ECE 517 Spring 2025 - E2505. Testing Answer Tagging]]
* [[CSC/ECE 517 Fall 2024 - E2508. Reimplement bidding-algorithm web service]]

CSC/ECE 517 Fall 2024 - E2505. Testing Answer Tagging

2025-03-17T23:24:38Z

==E2413. Testing - Answer Tagging==

This wiki page is for the description of changes made in Spring 2025, CSC/ECE 517 for the E2505 Testing - Testing Answer Tagging.

__TOC__

==Expertiza==
Describe expertiza

==Objective==
Describe our objective

==Controller and Spec Files==
Answer Tags
* [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/answer_tags_controller.rb answer_tags_controller.rb] with initial coverage of 0%
* [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/controllers/answer_tags_controller_spec.rb answer_tags_controller_spec.rb]

Tag Prompt Deployment
* [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/tag_prompts_controller.rb tag_prompt_deployment.rb] with initial coverage of 17.65%
* [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/models/tag_prompt_deployment_spec.rb tag_prompt_deployment_spec.rb]

==Testing Implementation==
===Answer Tags Controller===
This controller [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/answer_tags_controller.rb answer_tags_controller.rb] creates answer tags and tracks the number of tags a student has completed overall per assignment or questionnaire. The controllers' output is a JSON-formatted collection of response tags.

=====Methods=====
''action_allowed?'' : Determines if the user has the permission to see all the tags or create_edit a tag.

: Use Cases:

: * When it is a student session, access to index should be allowed.
: * When it is a student session, access to create_edit should be allowed.
: * When it is a student session, access to destroy should not be allowed.

: Edge Cases:

: * When the session is undefined, access to index should be inaccessible.
: * When the session is undefined, access to create_edit should be inaccessible.
: * When the session is undefined, access to destroy should be inaccessible.

''index'' : Returns all the tag prompt deployments in JSON format

: Use Cases:

: * When there are no tag prompts deployed, a empty list should be displayed.
: * When there is 1 tag prompt deployed, 1 should be displayed.
: * When there are tag prompts deployed with no associated assignment answer tag, tag prompts should not be displayed.
: * When there is an answer tag associated with an user_id, it should be filtered by an user_id.
: * When there is an answer tag associated with an assignment_id, it should be filtered by an assignment_id.
: * When there is an answer tag associated with a questionnaire_id, it should be filtered by a questionnaire_id.
: * When there is an answer tag associated with an user_id, assignment_id, and questionnaire_id, it should be filtered by a user_id, assignment_id, questionnaire_id.
: * When there is no answer tag associated with a assignment_id, no tag prompts are returned for a assignment_id with no associated answer tags.
: * When there is no answer tag associated with a questionnaire_id, no tag prompts are returned for a questionnaire_id with no associated answer tags.

: Edge Cases:

: * When user_id is undefined, an empty list of tags prompts should be returned.
: * When assignment_id is undefined, an empty list of tags prompts should be returned.
: * When questionnaire_id is undefined, an empty list of tags prompts should be returned.

''create_edit'' : Allow the creation or updating of an answer tag.

: Use Cases:

: * When a current tag is accessed, the current tag should be updated with new provided values.
: * When a current tag is accessed by a student, the current tag should not be updated with new values.

: Edge Cases:
: * When no mapping is found related to any tag_prompt_deployment for that tag (foreign key constraint), an empty list of tags prompts should be returned.

===Tag Prompt Deployment Controller===
The controller [https://github.com/CSC517-Project3/expertiza/blob/dev/app/controllers/tag_prompts_controller.rb tag_prompt_deployment.rb] is used by an instructor to view the tagging summary of the users that completed the answer tagging. It also indicates that comments are to be tagged for the characteristic specified by the tag prompt.
=====Methods=====
''tag_prompt'' : Tests that the tag prompt associated with the provided tag_prompt_id is correctly returned by the tag_dep.tag_prompt method.

: Use Cases:
: * When given a valid tag_prompt_id, it should return the associated tag prompt with the deployment.

: Edge Cases:
: * When given an invalid tag_prompt_id, it should not return a tag prompt with the deployment.

''get_number_of_taggable_answers'' : Calculates total taggable answers assigned for a user who participated in ``tag review assignment.''

: Use Cases:
: * When user_id is nil, it should return an error message.
: * When answer_length_threshold is null, it should return a count of tangible answers.
: * When answer_length_threshold is not null, it should return a count of taggable answers less than answers_one.

: Edge Cases:
: * When there are no responses, it should return zero as the count of taggable answers.
: * When questions are empty, it should return count of taggable answers as zero.

''assignment_tagging_progress'' : Accesses the percentage progress of answer tagging.

: Use Cases:
: * When there is a team, a question, and the assignment's rubrics do not vary by round, it should calculate the tagging progress for each user.
: * When there is a team, a question, and the assignment's rubrics do vary by round, it should calculate the tagging progress for each user considering all tagged items.

: Edge Cases:
: * When no questions are found, it should return an empty list.
: * When there are no teams or questions, it should return an empty list.

==Testing Details==
====Demo Videos====
put demo video here

====Using RSpec====

We implemented tests in [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/controllers/answer_tags_controller_spec.rb answer_tags_controller_spec.rb] and [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/models/tag_prompt_deployment_spec.rb tag_prompt_deployment_spec.rb].

=====How to See Test Coverage=====
# Run RSpec for [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/controllers/answer_tags_controller_spec.rb answer_tags_controller_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

# Run RSpec for [https://github.com/CSC517-Project3/expertiza/blob/dev/spec/models/tag_prompt_deployment_spec.rb tag_prompt_deployment_spec.rb], <code>sudo su</code>, <code>yum install lynx</code>, then <code>lynx ./coverage/index.html</code>

==Results==
results section

==Future Work==
1. future work description

==References==
# [https://github.com/expertiza/expertiza Expertiza GitHub]
# [https://github.com/CSC517-Project3/expertiza Project Repository]
# [https://github.com/orgs/CSC517-Project3/projects/1/views/1 Github Project Board]
# [https://github.com/expertiza/expertiza/pull/2775 Pull Request]
# [https://www.theodinproject.com/lessons/ruby-introduction-to-rspec RSpec]

CSC/ECE 517 Spring 2025

2025-03-17T18:39:04Z

Mwander5:

* [[CSC/ECE 517 Fall 2024 - E2505. Testing Answer Tagging]]
* [[CSC/ECE 517 Fall 2024 - E2508. Reimplement bidding-algorithm web service]]