CSC/ECE 517 Spring 2017/Convert Assignment Creation Form to ReactJS

Introduction

This page is a part of CSC/ECE 517 Final Project for Spring 2017 to describe the changes made by us to the open source software project Expertiza. We are converting the assignment creation form to ReactJS. Following contains a brief introduction to Expertiza, ReactJS followed by the problems we are tackling, our strategy for the implementation and the test plan.

Expertiza

Expertiza is a Ruby on Rails based web application where students can submit and peer review learning objects such as codes, articles, websites etc., It is an open source software project funded by National Science Foundation(NSF). The instructor has the capability to create assignments with varied specifications such as topics, courses, team size, level of reviews etc., later review the submitted work and provide feedback. Students can enter their submissions and also review others' work.

ReactJS

ReactJS is the javascript framework developed by Facebook to solve the specific problem, UI rendering. It is developed to solve the problem with complex binding in MVC framework using only one-way data binding. It is used for dynamic reloading of the page. It helps in reloading only the particular component required using Virtual DOM, which makes it fast by temporarily storing DOM

Reasons for using ReactJS

• It has every functionality that an user interface required
• Easy data binding.
• Only single component changes are stored/changed without reloading the complete page.
• Fast and efficient
• Easy to scale

Problem Statement

The Assignment Create and Edit Form are multi level forms. It consists of multiple inputs and user interactions. Many input types have dependency on interactions by the user. For example, on check for a particular checkbox, remaining form is displayed. The task is to convert this form into ReactJS component.

Tasks to be done

• Organize the form layout, create several mockups and validate them to your users
• Make the table in topics tab sortable by its header
• Allow users to edit / add topics in the table instead of loading a new page
• Implement the new layout and convert the javascript to a ReactJS component
• Validate user entries
• Fix tooltips that don’t work

Current Implementation

Assignment Creation

The assignment creation form consists of multiple inputs and requires interactions from the user. The current implementation is mostly in HTML with data validations being done by JQuery. When a user wants to create a new assignment by clicking the new assignment button, a server request is generated and new view is rendered. Again, another server request to make database entry is generated once the user fills in the data and clicks on 'save' button and again a new view is rendered. This kind of implementation doesn't support dynamic view rendering hence lacks the fluidity in overall user experience that one would expect.

Assignment Edition

Similar to assignment creation page, edit page lacks the dynamic view rendering which makes the user experience cumbersome. Every time user wants to make changes to the assignment, a server request is generated and new view is rendered. The save button hit on completion will again generate another server request and render a new view.

Make the table in topics tab sortable by its header

Currently after creating an assignment, we can add topics related to the assignment. The "Topics" tab in the edit assignment form shows the list of topics that are added to the assignment. The picture below shows the current page for displaying the list of topics of an assignment. The list is not sortable. The task is to make it sortable using ReactJS by topic id, topic name, Num. of slots, Available slots, Num. on waitlist columns as sorting on remaining columns doesn't give any meaningful display.

Validating user entries

The entries for the assignment creation are not according to any restrictions, that can add problem to database maintainence like sorting the entries, comparing them, retrieving. There are many such problem causing situations in the new assignment form, such as

• User can add the number as new assignment name or he can give only special characters for it like "$$$$".
• User can add sub directories in similar way as assignment name.
• Neglecting check boxes may lead to confusion with deadlines.

Proposed Solution

Assignment Creation

The new implementation will use ReactJS to generate a drop-down window on clicking on the New Assignment button (private/public) , providing same features as before. Database entry is made on submitting the form and the form is closed.

Files to be modified

• apps/assets/javascripts/tree_display.jsx.erb
• apps/controllers/assignments_controller.rb
• apps/controllers/tree_display_controller.rb

Assignment Edition

Similar to assignment creation, in the new implementation, using ReactJS, when the edit assignment button is clicked, instead of making a server request and rendering a new view, a drop down window appears and saving the details will make the database entry.Since all the processing is done on the client side there will be decrease in the number of server requests.

Files to be modified

• apps/views/tree_display/list.html.erb
• apps/views/assignments/edit.html.erb
• apps/views/assignments/edit/_general.html.erb

Make the table in topics tab sortable by its header

Following sub-tasks identified to implement sortable feature for topics table.

• Modify sign_up_sheet/_table_header.html.erb partial to change the table header fields to sortable type.
• Add sort functionality using ReactJS for each column that is meaningful to be sorted.

Validating user entries

The following tasks are to be implemented to achieve users validation,

• Adding the regular expression validation to avoid special characters in the names of assignment or directories.
• Alert messages to notify user if any important check boxes are missed.
• Validating edge cases like giving empty values.

Files to be modified

As, the project needs to be implemented in reactJS, which helps in reducing the complexing binding in MVC framework, only changing the javascript file can help to achieve this without changing model,

• app/assets/javascripts/tree_display.jsx.erb

Test Plan

Rails development is the Test Driven development, which helps in ensuring the implementation of all proposed implementations. We will be writing all the implementations proposed as tests that will eventually be red and try to make them green by adding to the development part.

For now the manual testing of these current implementations can help in testing the functionality from UI.

Manual Testing

Steps to manually test the feature are as follows:

Assignment Creation

• Log in as an instructor (user-name:instructor6 password:password)
• Go to Manage->Assignments and click on the Assignments tab.
• Click on the 'New public assignment' or 'New private assignment' button
• Verify if drop-down window is displayed.
• Make valid entries for the available fields and click on 'create'.
• Verify if new assignment is successfully created.

Assignment Creation

• Log in as an instructor (user-name:instructor6 password:password)
• Go to Manage->Assignments and click on the Assignments tab.
• Click on the Edit button for any of the available assignment.
• Verify if drop-down window is displayed.
• Make changes and click on 'save'.
• Verify if the changes made are successfully updated.

Make the table in topics tab sortable by its header

• Create an assignment
• Add 2 topics to the assignment
• Click sort on Topic ID and check if they are sorted
• Click sort on Topic title and check if they are sorted
• Similarly test using other columns

Validating user entries

• Log in as an instructor (user-name:instructor6 password:password)
• Go to Manage->Assignments and click on the Assignments tab.
• Click on the 'New public assignment' or 'New private assignment' button
• Try adding the assignment using the weird names, with special symbols, ignoring check boxes
• Verify if the assignment is shown in the table.

References

1. http://railscasts.com/episodes/228-sortable-table-columns sortable-columns
2. https://www.airpair.com/reactjs/posts/reactjs-a-guide-for-rails-developers adding-reactjs