Software Engineering

Homework 5: MVC Model

For this homework, you will create simple model classes in Rails, write tests to run them, and practice using the basic version control features of Git.

You will do this homework as a team; however, each member of your team will be responsible for the completion of a particular task.

Homework Workflow and How to Submit

Each team member will choose one task from the list below to complete. All team members must do a different task. If your team has only three members, then ignore Task 4.

Once everyone has selected their tasks, you must follow the workflow in this instructional video. Follow all the steps carefully, including submitting your team’s work as a GitHub release.

The Tasks

The specific tasks are detailed below. For each one of them:

• Create model classes as per the given UML class diagram.
  • Use rails generate model ...
• Add attribute validations to one of the classes as specified. Here is a page to help you:
  • https://guides.rubyonrails.org/v5.2.1/active_record_validations.html
• Write unit tests as follows for both classes. For each model class, write one test for valid values of all attributes. For each validation of each attribute, write one test that violates the validation rule. For example, if a model class has a string attribute with a length validation and a presence validation, you will have 3 tests: one with a valid string, one with a string of invalid length, and one with an empty string. Here are couple pages to help you:
  • https://guides.rubyonrails.org/v5.2.1/active_record_basics.html
  • https://guides.rubyonrails.org/v5.2.1/testing.html

Task 1

Model classes to create:

Add these validations to class School:

• length
  • name must be 50 characters or less.
• format
  • url must follow the general format of a URL.
• inclusion
  • category must be "elementary", "middle", or "high".
• uniqueness
  • url must be unique.
• presence
  • name, url, and category must have values.
• numericality
  • founded (year founded) must be less than or equal to the current year.

Task 2

Model classes to create:

Add these validations to class TeachingEvaluation:

• length
  • comment must be 5000 characters or less.
• format
  • metareviewer must following the following employee-ID format: a-123456-789 (i.e., a lowercase letter followed by a hyphen followed by 6 digits followed by a hyphen followed by 3 digits).
• inclusion
  • median_rating must be "poor", "fair", "good", or "excellent".
• uniqueness
  • comment must be unique. (No two reviews should be the same. If they were it would be a sign of poor quality.)
• presence
  • median_rating, metareviewer, and comment must have values.
• numericality
  • respondents must be greater than zero.

Task 3

Model classes to create:

Add these validations to class Student:

• length
  • last_name must be 30 characters or less.
• format
  • dob (date of birth) must follow the following date format: 01-23-1945 (i.e., a two-digit month followed by a hyphen followed by a two-digit day followed by a hyphen followed by a four-digit year).
• inclusion
  • honorific must be "Mr", "Ms", "Miss", "Master", or "Mx".
• uniqueness
  • last_name must be unique, because the school allows only one child per family name (which is very strange indeed!).
• presence
  • honorific and last_name must have values.
• numericality
  • iq must be a value from 0 (the lower bound for an IQ) to 300 (the highest IQ ever speculated to be possessed by a person).

Task 4

Model classes to create:

Add these validations to class HomeworkGradeSheet:

• length
  • text must be no more than 10000 characters.
• format
  • signature must be a 40-digit hex string. Each digit must be one of the following characters: 0123456789abcdef (case sensitive).
• inclusion
  • grade must be "A+", "A", "A-", "B+", "B", "B-", "C+", "C", "C-", "D+" , "D", or "F".
• uniqueness
  • signature must be unique.
• presence
  • grade, signature and feedback must have values.
• numericality
  • score must be between 0 and 100.

Rubric

Total points: 100

Below, the top-level number is the items total point value. If an item is not submitted at all or it is irredeemably broken, 0 points will be awarded for that item. The sub-bullets indicate standard deductions for errors in a submitted item. The deduction list below may not be complete because there may be mistakes that we did not expect. The deduction for an unexpected mistake will be assessed at the time it’s discovered and will reflect how severe the instructor thinks the mistake is.

• 20 Create model class
  • Wrong attribute name: -3 each
• 40 Attribute validations (total 9 or 10 validations in each task)
  • Missing/faulty validation: up to -5 each
• 40 Unit tests (for each validation there should be 2 test cases, 1 true and 1 false; also note that 1 test case may cover multiple validation)
  • Missing test case: -3 each

Other deductions:

• GitHub Submission:
  • No release: -10
  • Submitted release not actually the full submission: -7
  • Release does not follow naming convention: -3
  • No issue for task: -5
  • Issue doesn’t following naming convention: -5
  • No pull request for task: -10
  • Pull request doesn’t following naming convention: -5

© Scott D. Fleming 2019 • Made with GitHub Pages and Markdown