Add files via upload

Author: garrettbovo

Functions/__init__.py

@@ -0,0 +1,9 @@
+from .initRestaurants import initRestaurants
+from .menu import menu
+from .promptAction import promptAction
+from .implementAction import implementAction
+from .displayRestaurants import displayRestaurants
+from .displayRestRatings import displayRestRatings
+from .validIndex import validIndex
+from .addRating import addRating
+from .displayIndexRating import displayIndexRating

Functions/addRating.py

@@ -0,0 +1,48 @@
+from Classes import Rating
+import string
+
+def addRating(restaurant):
+    """This function gets all the required information from the user in order to create a new rating for a specified restaurant.  The function takes in one argument, which is mutable, when it is called, an object of type Restaurant.  The function then appends the new rating to the restaurant's already existing ratings."""
+
+    #declaration and initialization of variables
+    user = comment = ""
+    ratingValue = 0
+    flag = False
+    rating = Rating()
+
+    #prompting the user to enter his or her name
+    print("Please enter in the user...")
+    #while loop which runs until the user enters a valid name entry
+    while flag == False:
+        user = input("Please enter in a string with at least one character and at most ten characters: ")
+        #conditional statement checking if user's name is valid
+        if len(user) > 0 and len(user) <= 10:
+            flag = True
+    
+    #prompting the user to enter his or her rating value for the restaurant
+    print("Please enter in the rating...")
+    #while loop which runs until the user enters a valid rating index entry
+    while flag == True:
+        ratingValue = input("Please enter in a rating value between one and five: ")
+        #conditional statement which checks if user's input contains only integers and input's maximum length is one
+        if ratingValue not in string.digits or len(ratingValue) != 1:
+            continue
+        ratingValue = int(ratingValue)
+        #conditional statement which checks if the user's input is valid
+        if ratingValue > 0 and ratingValue < 6:
+            flag = False
+
+    #prompting the user to enter his or her comment for the rating
+    print("Please enter in the comment...")
+    #while loop which runs until the user enters a valid comment entry 
+    while flag == False:
+        comment = input("Please enter in a string with at least one character and at most five hundred characters: ")
+        #conditional statement which checks if the input's comment is valid
+        if len(comment) > 0 and len(comment) <= 500:
+            flag = True
+
+    #creating new instance of rating and adding rating to restaurant
+    rating = Rating(user, ratingValue, comment)
+    restaurant.setRatings(rating)
+
+    print("Rating successfully added\n")

Functions/displayIndexRating.py

@@ -0,0 +1,7 @@
+def displayIndexRating(restaurant, index):
+    """This function will the rating at the specified index within the specified restaurant's list.  This function also takes in one mutable, argument which is stored into restaurant, and one immutable argument which is stored into index.""" 
+
+    #printing rating at specified restaurant and index to user
+    print("User: " + restaurant.getRatings(index).getUser())
+    print("Rating Value: " + str(restaurant.getRatings(index).getRatingValue()))
+    print("Comment: " + restaurant.getRatings(index).getComment() + "\n")

Functions/displayRestRatings.py

@@ -0,0 +1,12 @@
+def displayRestRatings(restaurant):
+    """This function prints each rating for a specified restaurant.  This function takes in one mutable argument, which is an object of type Restaurant."""
+
+    print("\nRatings for " + restaurant.name)
+    #for loop which iterates over each restaurant rating
+    for i in range(0, restaurant.getRatingsSize()):
+        #printing each restaurant rating to the user
+        print("Rating Index: " + str(i))
+        print("User: " + restaurant.getRatings(i).getUser())
+        print("Rating Value: " + str(restaurant.getRatings(i).getRatingValue()))
+        print("Comment: " + restaurant.getRatings(i).getComment())
+        print("******************\n")

Functions/displayRestaurants.py

@@ -0,0 +1,11 @@
+def displayRestaurants(restaurants):
+    """This function will print every restaurant that is in the system, along with some additional information about the restaurant.  This function also takes in a singular, mutable, argument from the function's call."""
+
+    print("\nDisplay restaurants...")
+    #for loop which iterates over each index of the list of restaurants
+    for i in range(len(restaurants)):
+        #printing information about each restaurant to the user
+        print("Restaurant Index: " + str(i))
+        print("Restaurant Name: " + restaurants[i].getName())
+        print("Website: " + restaurants[i].getWebsite())
+        print("******************\n")

Functions/implementAction.py

@@ -0,0 +1,39 @@
+from Functions import displayRestaurants, displayRestRatings, validIndex, addRating, displayIndexRating
+
+def implementAction(restaurants, action):
+    """This function determines who the flow of the program will run based on the user's menu selection.  This function takes in two arguments into its parameter list: restaurants and action."""
+
+    #declaration and initialization of variables
+    index = 0
+    ratingIndex = 0
+
+    #conditional statement which checks if user's input is either "a" or "A"
+    if action == "a" or action == "A":
+        #calling displayRestaurants function to display all the restaurants in the system
+        displayRestaurants.displayRestaurants(restaurants)
+
+    #conditional statement which checks if user's input is either "b" or "B"    
+    elif action == "b" or action == "B":
+        print("\nDisplay all ratings for a restaurant...")
+        #getting a valid restaurant index from user by calling validIndex function
+        index = validIndex.validIndex(restaurants, "1")   
+        #calling displayRestaurants function to display all the restaurant's in the system          
+        displayRestRatings.displayRestRatings(restaurants[index])  
+
+    #conditional statement which checks if user's input is either "c" or "C"
+    elif action == "c" or action == "C":
+        print("\nAdd a rating to a restaurant...")
+        #getting a valid restaurant index from user by calling validIndex function
+        index = validIndex.validIndex(restaurants, "1")
+        #calling addRating function to add a rating to the specified restaurant
+        addRating.addRating(restaurants[index])
+
+    #conditional statement which checks if user's input is either "d" or "D"
+    elif action == "d" or action == "D":
+        print()
+        #getting a valid restaurant index from user by calling validIndex function
+        index = validIndex.validIndex(restaurants, "1")
+        #getting a valid rating index from the user by calling validIndex function 
+        ratingIndex = validIndex.validIndex(restaurants[index], "2") 
+        #calling displayIndexRating function to display a rating at the specified restaurant and at the specified index
+        displayIndexRating.displayIndexRating(restaurants[index], ratingIndex)    

Functions/initRestaurants.py

@@ -0,0 +1,64 @@
+from Classes import Rating, Restaurant
+
+def initRestaurants(restaurants):
+    """This function initializes five restaurants and appends each instance of the class Restaurant to a mutable list.  This mutable list is the function's only argument that is passed to the parameter."""
+
+    #declaration and initialization of variables
+    ratings = []
+    rating = Rating()
+    restaurant = Restaurant()
+
+    #creating two instances of Rating and appending them to a list of ratings
+    rating = Rating("Sally Jo", 4, "I love their vanilla ice cream!")
+    ratings.append(rating)
+    rating = Rating("Mike Smith", 2, "Their chocolate ice cream is just okay.")
+    ratings.append(rating)
+    #creating an instance of Restaurant and appending it to a list of restaurants
+    restaurant = Restaurant("Val's Ice Cream", ratings, "www.val'sIceCream.com")
+    restaurants.append(restaurant)
+    #clearing list of ratings
+    ratings.clear()
+
+    #creating two instances of Rating and appending them to a list of ratings
+    rating = Rating("Selena Gomez", 1, "No hamburgers.  Only chicken.")
+    ratings.append(rating)
+    rating = Rating("Cher", 5, "The fries are amazing!")
+    ratings.append(rating)
+    #creating an instance of Restaurant and appending it to a list of restaurants
+    restaurant = Restaurant("Chick-fil-a", ratings, "www.chick-fil-a.com")
+    restaurants.append(restaurant)
+    #clearing list of ratings
+    ratings.clear()
+
+    #creating two instances of Rating and appending them to a list of ratings
+    rating = Rating("Demi Lovato", 2, "The food was too greasy!")
+    ratings.append(rating)
+    rating = Rating("Halsey", 4, "I love their milkshakes.")
+    ratings.append(rating)
+    #creating an instance of Restaurant and appending it to a list of restaurants
+    restaurant = Restaurant("McDonald's", ratings, "www.mcDonald's.com")
+    restaurants.append(restaurant)
+    #clearing list of ratings
+    ratings.clear()
+
+    #creating two instances of Rating and appending them to a list of ratings
+    rating = Rating("Trippie Redd", 4, "I love their salads.")
+    ratings.append(rating)
+    rating = Rating("YNW Melly", 3, "Their food was decent.")
+    ratings.append(rating)
+    #creating an instance of Restaurant and appending it to a list of restaurants
+    restaurant = Restaurant("Applebee's", ratings, "www.applebee's.com")
+    restaurants.append(restaurant)
+    #clearing list of ratings
+    ratings.clear()
+
+    #creating two instances of Rating and appending them to a list of ratings
+    rating = Rating("Wendy Williams", 4, "They have the same name as me")
+    ratings.append(rating)
+    rating = Rating("Lil Durk", 2, "The wait was so long for food.")
+    ratings.append(rating)
+    #creating an instance of Restaurant and appending it to a list of restaurants
+    restaurant = Restaurant("Wendy's", ratings, "www.wendy's.com")
+    restaurants.append(restaurant)
+    #clearing list of ratings
+    ratings.clear()

Functions/menu.py

@@ -0,0 +1,10 @@
+def menu():
+    """This function prints the following menu whenever the function is called."""
+
+    #printing menu to the screen
+    print("Please select from the following options...")
+    print(" A  - Display Restaurants")
+    print(" B  - Display all ratings for a restaurant")
+    print(" C  - Add a rating to a restaurant")
+    print(" D  - Display a rating for a restaurant")
+    print(" Q  - Quit") 

Functions/promptAction.py

@@ -0,0 +1,14 @@
+from Functions import menu
+
+def promptAction():
+    """This function gets the user's input for his or her desired menu selection.  This function then returns a string call userInput which is the user's input."""
+
+    #declaration and initialization of variable
+    userInput = ""
+
+    #calling menu function, printing menu to screen, and getting user's input
+    menu()
+    userInput = input("What would you like to do?\n")
+
+    #returning user's input
+    return userInput

Functions/validIndex.py

@@ -0,0 +1,49 @@
+import string
+
+def validIndex(restaurant, guide):
+    """This function gets a valid restaurant index from the user.  When the user is prompted to enter a restaurant index, the index needs to be checked to ensure a restaurant at that index exists.  This function takes in one mutable argument, which is an instance of Restaurant.  The function then returns the user's valid restaurant index as a variable of type integer."""
+
+    #declaration and initialization of variables
+    x = nonNumCounter = 0
+    flag = False
+    index = ""
+
+    #conditional statement checking if guide is equal to one
+    if guide == "1":
+        x = len(restaurant)
+    #conditional statement checking if guide does not equal one    
+    else:
+        x = restaurant.getRatingsSize()    
+
+    #while loop which runs until the user enters a valid restaurant index
+    while flag == False:
+        #conditional statement checking if guide is equal to one
+        if guide == "1": 
+            #getting index input from user
+            index = input("Please enter in a Restaurant Index: ")
+        #conditional statement checking if guide does not equal one
+        else:
+            #getting index input from user
+            index = input("Please enter in a Rating Index: ")    
+
+        #conditional statement which checks if the length of the user's input is greater than zero
+        if len(index) > 0:
+            #for loop which iterates over each character of the user's input
+            for i in range(0, len(index)):
+                #conditional statement which checks if each character is a digit
+                if index[i] not in string.digits:
+                    nonNumCounter += 1
+                    
+        #conditional statement checking whether the number of non-digit characters is equal to zero
+        if nonNumCounter == 0:             
+            index = int(index)
+            #conditional statement which checks if the user's input is valid
+            if index < x:
+                flag = True
+
+        #conditional statement checking whether the number of non-digit characters is not equal to zero
+        else:
+            nonNumCounter = 0         
+
+    #returning the valid restaurant index as an integer
+    return index