Project Description

The Rental System

OPEN

• Open and read a stock file that represents the items that are currently in-stock.
• If the file does not exist - display an error
• If the file is empty - display an error
• You may assume all data is correct in stockfile.

CUSTOMER

• Add a customer to the system
• If customer already exists, display an error.

RENT

• Rents items to a customer.
• Until the customer's quota is full, finds the first item on the customer's queue that is also in-stock, removes it from the stock, and adds it to the customer's rented list.
• Once the quota is full, a receipt is printed.
• If the quota cannot be filled and a item was rented, a receipt is printed.
• If no item was rented, then no receipt is printed.

RETURN

• Return the item for the customer.
• Removing it from the customer's rented list and returning it to the stock.
• If the item was not rented by the customer, display an error.

QUEUE

• Add an item to a customer's queue (list of items they want to rent).
• If customer does not exist, display an error.
• If item is in the system (it is either in-stock or rented by another customer) - allow it to be queued.
• If item does not exist in the system, display an error
• The same item can be queued multiple times.

PRINT_ITEMS

• Prints a list of in-stock items (ItemNumber, Size, Title)

PRINT_CUSTOMERS

• Prints all customers and their current rentals - all personal information (name, username, CC#, address, city, state, zip) followed by all currently rented items (ItemNumber, Size, Title)

PRINT_USER

• Prints the queue for a particular user
• If username does not exist, display an error.
• If the user has no items in their queue, then leave the queue area blank.

PRINT_SORTED_CUSTOMERS

• Optional
• Prints a sorted list of customers and their current rentals - all personal information (name, username, CC#, address, city, state, zip) followed by all currently rented items (ItemNumber, Size, Title)
• Sorting is done based on username (ASCII sorting)

PRINT_LOG

• Optional
• Prints the transaction log for each user
• Prints the logs in same order as PRINT_CUSTOMERS
• If a user has no transactions, then leave the area blank or print an appropriate message.

Data

Rental System

• a collection of Customers
• a collection of items

Customers

Basic Functionality

Customers each have the following information, you may represent these in a variety of ways and are not limited to this exact representation:

• First name - sequence of any characters without spaces
• Last name - sequence of any characters without spaces
• Username - sequence of alphabetic, numerical, or the underscore ('_') characters - each username is unique
• Credit Card number - sequence of digits [0 - 9999999999999999], displayed as 16 digits
• Street Address - sequence of any characters with spaces
• City - sequence of any characters with spaces
• State - sequence of 2 characters (upper or lower) that match the 50 US states
• Zip - sequence of digits [1000 - 99999], displayed as 5 digits
• Queue - a list of items the user would like to rent
• Rented List - a list of items the user is currently renting

Polymorphic Functionality

Notice that all items in the rental system have the same charges - so renting a DVD for a Basic customer costs the same as renting a Book for a Basic customer. This is to simplify your code changes. If this were the final production system, this simplification may or may not be reasonable.

Your Customer class hierarchy should look essentially like this:

• Basic Customer - most basic deal
  
  • Pays $.99 per disc/volume
  • Limited to 3 items at a time
• Extended Customer - better deal
  
  • Pays a flat fee of $1.99 each time they rent 1 or more items
  • In addition, pays $.25 per disc/volume
  • Limited to 5 items at a time
• Premium Customer - best deal
  
  • Pays a flat fee of $3.99 each time they rent 1 or more items
  • Limited to 10 items at a time

Items

• Print the Item to an output stream
• Get the unique numerical identifier
• Get the Title
• Get the "size" of the item (for DVDs this is the number of discs, for Books this is the number of volumes), this should be a generic method that will work for both types (hint, hint)

Books

Books each have the following information:

• Book Number - unique identifier, sequence of digits [1 - 999999]
• Size (Number of Volumes) - sequence of digits that represent the number of volumes in this book [1 - 100]
• Title - sequence of any characters with white space

DVDs

DVDs each have the following information:

• DVD Number - unique identifier, sequence of digits [1 - 999999]
• Size (Number of Discs) - sequence of digits that represents the number of discs [1 - 100]
• Title - sequence of any characters with white space

Program Requirements

Templates

Your application must support a second command line parameter indicating which type of system the user would like to create, one with "DVDS" or "BOOKS". You can assume that the capitalized version are the ONLY acceptable version of the parameter. This command line parameter will follow the command-file name. If some other command is supplied, the program should print an error and terminate (unless you implement the extra credit as described).

Examples:

Proj5 command.txt DVDS
Proj5 command.txt BOOKS

Exceptions

All error conditions detected by your classes MUST result in the throwing of an exception. All appropriate code must be containted in a "try block". All exceptions must be caught where appropriate. All error messages that are currently required to be printed (i.e. improperly formatted commands) must continue to be printed.

All of your exception classes can (but don't have to) be in the same file (ex: Exceptions.h and Exceptions.cpp). You are encouraged (but not required) to use an inheritance hierarchy in defining your exception classes. You may design your exception classes as elaborately or simply as your code requires.

Utility Class

You can find Utility.o, Utility.cpp and Utility.h in the following location:

/afs/umbc.edu/users/d/a/dana3/pub/CMSC202/p5/

The one public method of the Utility class is:

static bool GetCommand(istream& sin, vector& command);

• Returns true if the command was correctly formatted and the data was of the correct type (digits versus strings)
• Returns false otherwise
• Parses the data, pushing each individual item onto a vector
• First item in the vector is the command name
• Each parameter to a command is a single entry in the vector
• Validates that all numbers are composed of digits
• Validates that the state in the address is one of the 50 states
• Validates the username by verifying that all characters are alphabetical, numerical or the underscore ('_')
• Stock file is not read, nor tested for existence
• The state of the vector is undefined if GetCommand fails
• The command as read from the file will be printed to the standard output stream
• Validates the Customer Type is one of the three acceptable types.

If you would like to have the Utility class throw exceptions - you must add this functionality yourself (since everyone will have different exception classes, it was unreasonable to add this as a standard feature).

Extra Credit

Supporting Arbitrary Costs - 10 pts

Your system should expand the Book class to support the following cost structure:

• Basic Customer - most basic deal
  
  • Pays $2.99 per disc/volume
  • Limited to 2 items at a time
• Extended Customer - better deal
  
  • Pays a flat fee of $5.99 each time they rent 1 or more items
  • In addition, pays $.75 per disc/volume
  • Limited to 8 items at a time
• Premium Customer - best deal
  
  • Pays a flat fee of $7.99 each time they rent 1 or more items
  • Limited to 15 items at a time

Your system will be tested using the following command line:
Proj5 command.dat BOOKS_EC
Your system must continue to function normally with the BOOKS parameter in the normal test cases.

Supporting Arbitrary Types - 10 pts

Any type that can be used in this system must have 3 components:

• Unique identifier - this can be any type of object and should be parameterized in your template (i.e. could be a string, int, vector, ... any type that supports all of the standard operators >>, <<, ==, <, etc.)
• Description - this must be a string
• Size - this must be an unsigned integer

Your program will be tested by supplying a third command-line parameter of a type that represents the type of object that will represent the Unique identifier. For simplicity - your code need only accept "STRING" and "INT".

In example:
Proj5 command.dat BOOKS INT
Indicates that we want a Rental System of Books that have an integer as their Unique identifier. You can assume that the correct type will be supplied in the command file. If this parameter is not supplied, then you can assume whatever type your current system supports - this will support "backwards compatibility" with the normal test suite. This should work for both Books and DVDs with strings and ints. You can safely assume that all integer identifiers will be positive. Do not worry about range-testing these identifiers, you can assume they are all valid. You need only assume that the operator==, operator<< and operator>> exist for the templated type.

Command File Requirements

Your program is required to repeat the command as read from the file. The Utility class will take care of this for you, if you use it.

Commands

Valid commands for the system are as follows:

• OPEN <stock filename>
  
  
• CUSTOMER <first name> <last name> <username> <card number> <customer type>
  <address>
  <city> <state> <zip code>
  
  
• RENT <username>
  
  
• RETURN <item number> <username>
  
  
• QUEUE <item number> <username>
  
  
• PRINT_ITEMS
  
  
• PRINT_CUSTOMERS
  
  
• PRINT_USER <username>
  
  
• PRINT_SORTED_CUSTOMERS [optional - old extra credit, will not be used]
  
  
• PRINT_LOG [optional - old extra credit, will not be used]
  
  

Command File Error Checking

• <customer type> must be one of the following strings: "BASIC", "EXTENDED", or "PREMIUM". Each must be capitalized. The Utility class will validate this for you.
• If a command is incorrect in any way (format or content), it shall be discarded and processing of the command file shall continue. Must include an error message.
• If a command cannot be executed (like queueing a DVD/Book for a non-existant customer), a message shall be printed and processing of the command file shall continue.
• Data must be validated. Utility takes care of this, mostly. Integer ranges are not validated by Utility.
• Names, addresses, and other "word" based items, unless specifically limited - they may contain any printable character.
• Printable characters are defined as any character that can be typed on the keyboard. You need not validate these characters at all.

Sample Command File

Stock File

Sample Stock File

General Requirements

• In keeping with course standards, main( ) will be implemented in a file named Proj5.cpp.
• Prototypes for any helper functions called from main will be located in Proj5Aux.h and the functions themselves implemented in Proj5Aux.cpp.
• Each class will be defined in a separate header (e.g. Customer.h) file and implemented in a similarly named .cpp file (e.g. Customer.cpp).
• You must provide a makefile for this project which compiles and links all files when the grader types
  make Proj5.
• Your executable must be named Proj5.

Note that not all of the programming details have been spelled out for you. For example, the rental system must keep track of which DVD is rented by whom, but there's no indication about how that should be done. This is intentional....you are required to give the project design serious thought before writing code. Remember to think ahead to what might be assigned in future projects and design your classes so that they are easily modifiable.

Program Output

1. Customer credit card numbers must be displayed in the form 1234-5678-9012-3456.
2. All monetary values must be displayed with 2 decimal places.
3. When displaying a list of DVDs or customers, data must be aligned in columns.
4. Lists of DVDs/Books/customers shall be displayed in the order DVDs/Books/customers were added to the rental system.
5. As the stock file is processed, messages informing the user of each item that is being added shall be displayed

1. The renter's first and last name total no more than 20 characters.
2. The renter's username totals no more than 20 characters.

Sample Output

Free Advice and Information

1. Every attempt has been made to highlight the changes in BLUE so that you can quickly and easily see what functionality has changed. Remember to build the new functionality slowly - use modular composition - add one new piece at a time, ensuring that the system still works correctly after adding each piece.
2. DO NOT attempt to develop this entire application at once! We recommend adding the components in the following order to limit changes:
   • Change the PRINT_DVDS to PRINT_ITEMS
   • Write a single Exception class.
   • Convert all error messages into exception throws.
   • Add try/catch blocks to catch these exceptions.
   • Add additional exception classes to handle more specific errors.
   • Extend your try/catch blocks to handle these exceptions.
   • Modify the Customer class to handle templated types (if necessary). Start with only DVD objects.
   • Modify the Rental System class to handle templated types. Start with only DVD objects.
   • Build the Book class(es).
   • Hard-code the creation of a Rental System of Books.
   • Extend the command line to allow creation of Rental System using either Books or DVDs.
   • Create several testing command files to thoroughly test your system.
3. Carefully consider your design. In general, a minimal class interface is best. Consider how best to reuse code.
4. Functions called from main that are not part of any class are permitted. If you create new functions, their prototypes must be found in Proj5Aux.h and they must be implemented in Proj5Aux.cpp. You must modify the makefile provided to account for these files.
5. Your program must provide adequate error checking as described above.
6. Your program will be tested with a variety of conditions.
7. Use incremental development. Add ~5 lines, save, compile, test. Use function/method stubs to develop a class incrementally.
8. Don't procrastinate.

Project Design Assignment