class CarParkingLot.ipynb

{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": 4,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Entrance Time: 2023-12-29 19:11:10.977379\n",
      "Entrance Fee: 2 EUR\n",
      "Leave Time:2023-12-29 19:47:20.644552\n",
      "Printing total cost ...\n",
      "Total Cost: 5 EUR, buckles up and have a safe trip!\n"
     ]
    }
   ],
   "source": [
    "from datetime import datetime\n",
    "\n",
    "class CarParkingLot:\n",
    "    '''\n",
    "    Class CarParkingLot contains the following set of functions (see below), these functions define:\n",
    "    - shared variables initialization;\n",
    "    - entrance timestamp;\n",
    "    - leave timestamp;\n",
    "    - calculates overall time in minutes;\n",
    "    - calculation of total cost;\n",
    "    - order of execution\n",
    "\n",
    "    The case:\n",
    "    1. There are a Driver (in the car), Parking Payment System and a paid parking lot, i.e. in front of a Mall;\n",
    "    2. Driver enters a parking lot and leaves a car for shopping;\n",
    "    3. Some time later Driver comes back and leaves by car the parking lot;\n",
    "    4. While entering / leaving a Driver / a car interacts with Parking Payment System:\n",
    "    4.1 when Driver enters, entrance_time is logged;\n",
    "    4.2 when Driver leaves, leave_time is logged;\n",
    "    5. Parking Payment System:\n",
    "    5.1 Calculates time of stay in minutes;\n",
    "    5.2 Calculates overall cost of stay;\n",
    "    5.3 Presents Driver with a bill: price is the most critical in the bill;\n",
    "    5.4 Driver pays;\n",
    "    6. Driver leaves the parking lot by car\n",
    "    ''' \n",
    "    \n",
    "    def __init__(self):\n",
    "        ''' \n",
    "        initialization of the following variables as they are listed in the function:\n",
    "        Variables initialized with None values, since these values will be entered by a driver when entering / leaving parking lot:\n",
    "        - driver enters parking lot, here we save a timestamp, like: 2023-12-29 15:17:25.127610;\n",
    "        - driver leaves parking lot, here we save a timestamp, like: 2023-12-29 15:17:25.127610;\n",
    "        The following variables are constants, their values are in EUR:\n",
    "        - entrance fee;\n",
    "        - first hour parking fee;\n",
    "        - each next hours parking fee\n",
    "\n",
    "        Main logic:\n",
    "        - Time of stay is calculated via entrance_time and leave_time;\n",
    "        - 2 EUR is a fixed fee, just for entrance;\n",
    "        - 3 EUR is a fee for the first hour of parking;\n",
    "        - 4 EUR is a fee for each hour after the first hour of parking\n",
    "\n",
    "        Example:\n",
    "        Driver enters a parking lot, leaves a car for two hours and leaves the parking lot (by car):\n",
    "        total fee = 2 EUR (entrance fee) + 3 EUR (first hour of parking) + 4 EUR (each next hour after the first hour) = 9 EUR\n",
    "        Driver is presented with the bill: 9 EUR\n",
    "        '''\n",
    "        self.entrance_time = None\n",
    "        self.leave_time = None\n",
    "        self.entrance_fee = 2\n",
    "        self.first_hour_fee = 3\n",
    "        self.next_hour_fee = 4\n",
    "    \n",
    "    def read_entrance_time(self):\n",
    "        '''\n",
    "        This function reads entrance timestamp as the current time as the user confirms, saves it into entrance_time, and returns it.\n",
    "        Additionally, it presents the user with the entrance fee for FYI purpose.\n",
    "        '''\n",
    "        entrance_time_confirmation = input(\"Parking time starts, please confirm time! Entrance Parking Fee is 2 EUR. Possible options yes / cancel:\\n\")\n",
    "        if entrance_time_confirmation == 'yes':\n",
    "            self.entrance_time = datetime.now()\n",
    "            print(f\"Entrance Time: {self.entrance_time}\\nEntrance Fee: {self.entrance_fee} EUR\")\n",
    "            return self.entrance_time\n",
    "        else:\n",
    "            print('Start again or see you later\\n')\n",
    "\n",
    "    def read_leave_time(self):\n",
    "        '''\n",
    "        This function reads leave timestamp as the current time as the user confirms, saves it into leave_time, and returns it.\n",
    "        '''\n",
    "        leave_time_confirmation = input(\"You are leaving, you are char, possible options yes / cancel:\\n\")\n",
    "        if leave_time_confirmation == 'yes':\n",
    "            self.leave_time = datetime.now()\n",
    "            print(f\"Leave Time:{self.leave_time}\\nPrinting total cost ...\")\n",
    "            return self.leave_time\n",
    "        else:\n",
    "            print('Try again or come back later later\\n')\n",
    "\n",
    "    def total_time_calculation(self, entrance_time, leave_time):\n",
    "        '''\n",
    "        This function calculates the total time of stay in total_minutes and returns it.\n",
    "        '''\n",
    "        total_time = (leave_time - entrance_time)\n",
    "        total_minutes = round(total_time.total_seconds() / 60)   \n",
    "        return total_minutes\n",
    "\n",
    "    def total_cost_calculation(self, total_minutes):     \n",
    "        '''\n",
    "        This function is the most important and needs to be tested by QA carefully. It contains business logic.\n",
    "        total_cost contains a price of occupying a parking lot.\n",
    "\n",
    "        Examples:\n",
    "        total cost = 2 EUR (entrance fee) + 3 EUR (first hour of parking) + 4 EUR (each next hour after the first hour) = 9 EUR\n",
    "        Driver is presented with the bill: 9 EUR\n",
    "\n",
    "        total cost = 2 EUR (entrance fee) + 3 EUR (first hour of parking) + 4 EUR * 2 hours (each next hour after the first hour) = 13 EUR\n",
    "        Driver is presented with the bill: 13 EUR\n",
    "        '''\n",
    "        if total_minutes <= 60:\n",
    "            total_cost = self.entrance_fee + self.first_hour_fee\n",
    "        else:\n",
    "            full_hours = total_minutes // 60\n",
    "            remaining_minutes = total_minutes % 60\n",
    "\n",
    "            total_cost = self.entrance_fee + self.first_hour_fee + (full_hours * self.next_hour_fee)\n",
    "            if remaining_minutes > 0:\n",
    "                total_cost += self.next_hour_fee\n",
    "\n",
    "        print(f\"Total Cost: {total_cost} EUR, buckles up and have a safe trip!\")\n",
    "\n",
    "    def main(self): \n",
    "        ''' \n",
    "        Define order of execution\n",
    "        '''\n",
    "        entrance_time = self.read_entrance_time()\n",
    "        leave_time = self.read_leave_time()\n",
    "        total_minutes = self.total_time_calculation(entrance_time, leave_time)\n",
    "        self.total_cost_calculation(total_minutes)\n",
    "\n",
    "# here's how it runs\n",
    "if __name__ == \"__main__\":\n",
    "    parking_lot = CarParkingLot() # create instance of class\n",
    "    parking_lot.main() # run main() which triggers execution of relevant functions one by one\n"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "qj",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.11.5"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}