Skip to content

Latest commit

 

History

History
80 lines (53 loc) · 3.35 KB

spec.md

File metadata and controls

80 lines (53 loc) · 3.35 KB
Raw

Specifications for the Sinatra Assessment

Specs:

  • Use Sinatra to build the app

    • Gemfile contains Sinatra.
    • Used Sinatra to create MVC framework via the Corneal gem.

  • Use ActiveRecord for storing information in a database

    • Gemfile contains ActiveRecord.
    • Used SQLite3 gem in development phases, Heroku branch uses PG gem for deployment to Heroku.

  • Include more than one model class (e.g. User, Post, Category)

    • This project has three models: Account, Pet, and User.

  • Include at least one has_many relationship on your User model (e.g. User has_many Posts)

    • The User model contains the relationship has_many :pets

  • Include at least one belongs_to relationship on another model (e.g. Post belongs_to User)

    • The Pet model contains the relationship belongs_to :User
    • The User model contains the relationship belongs_to :Account

  • Include user accounts with unique login attribute (username or email)

    • The User model uses AR validation
      • validates :email, uniqueness: { case_sensitive: false }
    • The Account model used AR validation
      • validates :username, presence: { message: "is required." }
      • validates :username, uniqueness: { case_sensitive: false, message: "is already taken, please try again." }

  • Ensure that the belongs_to resource has routes for Creating, Reading, Updating and Destroying

    • The CRUD functions for the project are all taken care of via the User model, currently updates to the Account model are not permitted.

  • Ensure that users can't modify content created by other users

    • A helper method aptly named redirect_if_cannot_edit takes care of ensuring only owners of the content can edit/delete that content.

  • Include user input validations

    • Account Model
      • has_secure_password
      • validates :username, presence: { message: "is required." } -- validates :username, uniqueness: { case_sensitive: false, message: "is already taken, please try again." }
    • User Model
      • validates :email, uniqueness: { case_sensitive: false }
      • validates :phone, format: { with: /[1-9]\d{2}-\d{3}-\d{4}/, message: "only allows numbers and must be formatted as 'XXX-XXX-XXXX'."}
      • Note: The phone number formatting is different on the Heroku branch, mobile input does not provide a hyphen for user formatting. Future feature to format phone number after input planned.
    • Pet Model
      • No validators at this time.

  • Your README.md includes a short description, install instructions, a contributors guide and a link to the license for your code

Confirm

  • You have a large number of small Git commits

    • Master Branch - 90 commits
    • Step-1 Branch - 40 commits
    • Step-2 Branch - 79 commits
    • Step-3 Branch - 86 commits
    • Heroku Branch - 101 commits
    • TOTAL COMMITS as of 12/15/19: 396

  • Your commit messages are meaningful

  • You made the changes in a commit that relate to the commit message

  • You don't include changes in a commit that aren't related to the commit message

Bonus or Extra Project Features

  • Other AR relationships

    • The Account model contains the relationship has_one :User

  • BONUS - not required - Display validation failures to user with error message (example form URL e.g. /posts/new)

    • This project uses both the AR validation error messages as well as flash messaged to assist the end user.