Assignment Requirements
This page lists the example project requirements for Example 14 in CC 410. Read the requirements carefully and discuss any questions with the instructors or TAs.
Purpose
This example will cover updating an existing project to include server-side form validation.
General Requirements
- All code must be object-oriented.
- All executable code must be within a class
- Python package files such as
__init__.py
and __main__.py
are exempt.
- Classes must be organized into packages based on common usage.
- This project must include automation for compilation and execution.
- Java: Use Gradle with the
application
and jacoco
plugins. The project should compile without errors.
- Python: Use tox configured to use Python 3.10 and a requirements file to install libraries.
- All code must properly compile or be interpreted.
- Java: It must compile using Gradle.
- Python: It must be interpreted using Python 3.10. Where specified, type hints should be included in the code, and all code should pass a strict Mypy type check.
- There are instances where Mypy is unable to determine the type of lambda expressions used as commands with buttons. This error can be ignored.
- Unit tests are not required.
- Documentation comments are not required for this example, but they are recommended for your own use.
- All code submitted must be free of style errors. We will be using the Google Style Guide for each language.
- Style errors related to documentation comments (or lack thereof) will be ignored.
- Java: Use Checkstyle 10.6.0+ and the Google Style Configuration.
- You may modify the configuration to allow 4 space indentations instead of 2 space indentations.
- Python: Use Flake8 with the
flake8-docstrings
and pep8-naming
plugins. Code should conform to PEP 8 style with Google style docstrings.
- All HTML must conform to the HTML5 standard. Use the W3C Validator to check your rendered pages if desired.
- Submissions to Canvas should be tagged GitHub releases that are numbered according to Semantic Versioning.
Assignment Requirements
Add server-side form validation using the features in Spring Boot (Java) or WTForms (Python) to add the following server-side validation options to the Edit Movie form:
- Title must be not null and at least 1 character long
- Genre must be not null and at least 1 character long
- MPAA Rating must be one of “G”, “PG”, “PG-13”, “R”
- IMDB Rating must be a floating point value between 0 and 10
- Rotten Tomatoes Rating must be an integer value between 0 and 100
Time Requirements
Completing this project is estimated to require 1-2 hours.
Grading Rubric
This assignment will be graded based on the rubric below:
- Title Validation: 20%
- Genre Validation: 20%
- MPAA Rating Validation: 20%
- IMDB Rating Validation: 20%
- Rotten Tomatoes Rating Validation: 20%
The following deductions apply:
- Any portion of the project which will not compile (Java), pass a strict type check (Python), or execute properly will be given a grade of 0.
This is not an exhaustive list of possible deductions. The instructors will strive to provide reasonable and fair grading, but we can’t predict all possible defects. It is up to the student to ensure that the project is complete and correct before submission.
Submission
Submit this assignment by creating a release on GitHub and uploading the release URL to the assignment on Canvas. You should not submit this Codio project or mark it as complete in Codio, in case you need to come back to it and make changes later.
Java
YouTube Video
Outline
Here is a basic outline of the steps to follow to complete this example.
- Clone Starter Code from GitHub
- Install SDKMAN
Instructions
curl -s "https://get.sdkman.io" | bash
-
Close and Reopen Terminal to load SDK Man
-
Install Gradle
- Compile, Run & Test Existing Project
cd java
gradle run
gradle check
-
Confirm that project runs and has no style errors.
-
Follow along with the video to update the project.
-
When complete, use Git to commit and push updated code.
git add .
git commit -m "Example Complete"
git push
- On GitHub, create a release tag and submit URL to Canvas for grading.