Skip to content
This repository has been archived by the owner on Dec 5, 2021. It is now read-only.

Latest commit

 

History

History
96 lines (80 loc) · 5.03 KB

MY_README.md

File metadata and controls

96 lines (80 loc) · 5.03 KB

Takeaway Challenge (Week 2)

Task

To design a takeaway programme using TDD that fulfils the User Story requirements (below).

How To Use

git clone https://github.com/lukewickens1989/takeaway-challenge.git
bundle install

User Stories

As a customer
So that I can check if I want to order something
I would like to see a list of dishes with prices

As a customer
So that I can order the meal I want
I would like to be able to select some number of several available dishes

As a customer
So that I can verify that my order is correct
I would like to check that the total I have been given matches the sum of the various dishes in my order

As a customer
So that I am reassured that my order will be delivered on time
I would like to receive a text such as "Thank you! Your order was placed and will be delivered before 18:52" after I have ordered

Project Tasks

  • I would like to see a list of dishes with prices.
  • I would like to be able to select some number of several available dishes.
  • I would like to check that the total I have been given matches the sum of the various dishes in my order.
  • I would like to receive a text such as "Thank you! Your order was placed and will be delivered before 18:52" after I have ordered.

Initial Action Plan

  1. Create a menu hash with dishes as keys and prices as values
  2. Create a recepit array (so that the order can be seen and checked upon purchase)
  3. Print out the menu on entry and upon request
  4. Ask for the customers dishes
  5. Ask for the dish quantity
  6. Multiply the price by the quantity to a total variable
  7. Check if order is complete after every customer dish entry
  8. Once confirmed that the order is complete:
    1. Print the recepit
    2. Print the total
  9. Get customer to confirm price
  10. Request customer name and mobile number
  11. Use TwilioAPI to send customer personalised text with delivery time (+1 hour from now)

Commit Information

  1. 1st Commit

    • Set up own README.md (MY_README.md) to document process.
    • Set up initial file structure (lib/spec files).
    • Added menu.rb and menu_spec.rb
    • Wrote menu functionality (Provided menu hash, can call open on menu to display the current items and prices).
    • TDD the menu with 100% test coverage.

  2. 2nd Commit

    • Added receipt files (spec and lib) to use to record customer order and costs.
    • Added takeaway files (spec and lib) to provide takeaway functionality.
    • Added placeholders in receipt file to plan out what methods I want to be able to call.

  3. 3rd Commit

    • Changed name of receipt to order to better reflect nature of the file.
    • Added in functionality for the following methods:
      • add_to_basket - Adds customer items to the basket with quantities provided.
      • order_summary - Print of the quantity and item for the customer.
      • order_cost - Calculates the cost of all items in the basket.
      • empty_basket - Deletes all items in the basket.
    • TDD all of the above methods with 100% test coverage.
    • Analysed code quality using 'rubocop' gem:
      • All checked and only offence is the use of the string print formatter to return the price to two decimal places.

  4. 4th Commit

    • Added takeaway functionality for the following methods:
      • open_menu - Allows customer to open menu from the takeaway interface.
      • add_to_order - Allows customer to add to their order from the takeaway interface.
      • view_basket - Displays the basket of current items along with quantity and price (both per item and quantity total).
      • order_total - Prints out the total cost of the order to the customer
      • checkout - checks the price (check_price?) matches and allows the customer to pay if matches and raises and error if not.
      • check_price? - checks the price the customer has input to pay again the total order price and returns a boolean.
    • Added additional information to the order_summary method to return not only the quantity and item but also the price per individual item and the total cost of the item with the quantity specified.
    • TDD all of the above methods with 100% test coverage.

  5. 5th Commit

    • Added the use of Twillio to project.
    • Set up new files for messaging and messaging_spec.
    • Set up functionality for accessing Twilio API and sending specified text message.
    • Added feature of calculating the ETA of delivery by using the Time.now feature.
    • Set up accessing the Twilio API feature from the takeaway file through the checkout method.
    • TDD all of the above with 98.70% (unsure of how to test for the output of calling send_message function).
    • Final test in IRB to make sure all features and functionality was working as intended.
    • Checked with RuboCop - two main issues are:
      • The use of string print formatter to fix decimal place issue with printing price.
      • Long line used in order_summary method to print out item, price, quantity, quantity*price information.