For this assignment, we'll be working with a restaurant review domain.
We have three models: Restaurant
, Review
, and Customer
.
For our purposes, a Restaurant
has many Review
s, a Customer
has many
Review
s, and a Review
belongs to a Restaurant
and to a Customer
.
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.
- SQLAlchemy Migrations
- SQLAlchemy Relationships
- Class and Instance Methods
- SQLAlchemy Querying
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 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 are
also encouraged to use the seeds.py
file to create sample data to test your
models and relationships.
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.
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.
The starter code has migrations and models for the initial Restaurant
and
Customer
models, and seed data for some Restaurant
s and Customer
s. The
schema currently looks like this:
Column | Type |
---|---|
name | String |
price | Integer |
Column | Type |
---|---|
first_name | String |
last_name | String |
You will need to create the migration for the reviews
table using the
attributes specified in the deliverables below.
Write the following methods in the classes in the files provided. Feel free to build out any helper methods if needed.
Remember: SQLAlchemy give your classes access to a lot of methods already! Keep in mind what methods SQLAlchemy gives you access to on each of your classes when you're approaching the deliverables below.
Before working on the rest of the deliverables, you will need to create a
migration for the reviews
table.
- A
Review
belongs to aRestaurant
, and aReview
also belongs to anCustomer
. In your migration, create any columns yourreviews
table will need to establish these relationships. - The
reviews
table should also have:- A
star_rating
column that stores an integer.
- A
After creating the reviews
table using a migration, use the seeds.py
file to
create instances of your Review
class so you can test your code.
Once you've set up your reviews
table, work on building out the following
deliverables.
Use SQLAlchemy query methods where appropriate.
Review customer()
- should return the
Customer
instance for this review
- should return the
Review restaurant()
- should return the
Restaurant
instance for this review
- should return the
Restaurant reviews()
- returns a collection of all the reviews for the
Restaurant
- returns a collection of all the reviews for the
Restaurant customers()
- returns a collection of all the customers who reviewed the
Restaurant
- returns a collection of all the customers who reviewed the
Customer reviews()
- should return a collection of all the reviews that the
Customer
has left
- should return a collection of all the reviews that the
Customer restaurants()
- should return a collection of all the restaurants that the
Customer
has reviewed
- should return a collection of all the restaurants that the
Use python debug.py
and check that these methods work before proceeding. For
example, you should be able to call session.query(Customer).first().restaurants
and see a list
of the restaurants for the first customer in the database based on your seed
data; and session.query(Review).first().customer
should return the customer for the first
review in the database.
Customer full_name()
- returns the full name of the customer, with the first name and the last name concatenated, Western style.
Customer favorite_restaurant()
- returns the restaurant instance that has the highest star rating from this customer
Customer add_review(restaurant, rating)
- takes a
restaurant
(an instance of theRestaurant
class) and a rating - creates a new review for the restaurant with the given
restaurant_id
- takes a
Customer delete_reviews(restaurant)
- takes a
restaurant
(an instance of theRestaurant
class) and - removes all their reviews for this restaurant
- you will have to delete rows from the
reviews
table to get this to work!
- takes a
Review full_review()
- should return a string formatted as follows:
Review for {insert restaurant name} by {insert customer's full name}: {insert review star_rating} stars.
Restaurant fanciest(), this method should be a class method
- returns one restaurant instance for the restaurant that has the highest price
Restaurant all_reviews()
- should return an list of strings with all the reviews for this restaurant formatted as follows:
[
"Review for {insert restaurant name} by {insert customer's full name}: {insert review star_rating} stars.",
"Review for {insert restaurant name} by {insert customer's full name}: {insert review star_rating} stars.",
]