andrew-nzioki/code-challenge-restaurant

Object Relations Code Challenge - Restaurants

For this assignment, we'll be working with a Yelp-style domain.

We have three models: Restaurant, Customer, and Review.

For our purposes, a Restaurant has many Reviews, a Customer has many Reviews, and a Review belongs to a Customer and to a Restaurant.

Restaurant - Customer is a many to many relationship.

Note: You should draw your domain on paper or on a whiteboard before you start coding. Remember to identify a single source of truth for your data.

Topics

• Classes and Instances
• Class and Instance Methods
• Variable Scope
• Object Relationships
• lists and list Methods

Instructions

To get started, run pipenv install while inside of this directory.

Build out all of the methods listed in the deliverables. The methods are listed in a suggested order, but you can feel free to tackle the ones you think are easiest. Be careful: some of the later methods rely on earlier ones.

Remember! This code challenge does not have tests. You cannot run pytest. You'll need to create your own sample instances so that you can try out your code on your own. Make sure your relationships and methods work in the console before submitting.

We've provided you with a tool that you can use to test your code. To use it, run python tools/debug.py from the command line. This will start a ipdb session with your classes defined. You can test out the methods that you write here. You can add code to the tools/debug.py file to define variables and create sample instances of your objects.

Writing error-free code is more important than completing all of the deliverables listed - prioritize writing methods that work over writing more methods that don't work. You should test your code in the console as you write.

Similarly, messy code that works is better than clean code that doesn't. First, prioritize getting things working. Then, if there is time at the end, refactor your code to adhere to best practices. When you encounter duplicated logic, extract it into a shared helper method.

Before you submit! Save and run your code to verify that it works as you expect. If you have any methods that are not working yet, feel free to leave comments describing your progress.

Deliverables

Write the following methods in the classes in the files provided. Feel free to build out any helper methods if needed.

Some of the methods listed are provided to you in the starter code. You should check that they work correctly, and that you understand them.

Initializers, Readers, and Writers

Customer

• Customer __init__()
  • Customer should be initialized with a given name and family name, both strings (i.e., first and last name, like George Washington)"
• Customer given_name()
  • returns the customer's given name
  • should be able to change after the customer is created
• Customer family_name()
  • returns the customer's family name
  • should be able to change after the customer is created
• Customer full_name()
  • returns the full name of the customer, with the given name and the family name concatenated, Western style.
• Customer all()
  • returns all of the customer instances

Restaurant

• Restaurant __init__()
  • Restaurants should be initialized with a name, as a string
• Restaurant name()
  • returns the restaurant's name
  • should not be able to change after the restaurant is created

Review

• Review __init__()
  • Reviews should be initialized with a customer, restaurant, and a rating (a number)
• Review rating()
  • returns the rating for a restaurant.
• Review all()
  • returns all of the reviews

Object Relationship Methods

Review

• Review customer()
  • returns the customer object for that review
  • Once a review is created, should not be able to change the customer
• Review restaurant()
  • returns the restaurant object for that given review
  • Once a review is created, should not be able to change the restaurant

Restaurant

• Restaurant reviews()
  • returns a list of all reviews for that restaurant
• Restaurant customers()
  • Returns a unique list of all customers who have reviewed a particular restaurant.

Customer

• Customer restaurants()
  • Returns a unique list of all restaurants a customer has reviewed
• Customer add_review(restaurant, rating)
  • given a restaurant object and a star rating (as an integer), creates a new review and associates it with that customer and restaurant.

Aggregate and Association Methods

Customer

• Customer num_reviews()
  • Returns the total number of reviews that a customer has authored
• Customer find_by_name(name) class method
  • given a string of a full name, returns the first customer whose full name matches
• Customer find_all_by_given_name(name) class method
  • given a string of a given name, returns an list containing all customers with that given name

Restaurant

• Restaurant average_star_rating()
  • returns the average star rating for a restaurant based on its reviews
  • Reminder: you can calculate the average by adding up all the ratings and dividing by the number of ratings

Rubric

You can find the rubric for this assessment here.