leojkwan / cashmoneyblocks-ios-0615-public

tags	languages
blocks	objc

CashMoneyBlocks

Instructions

You are highly encouraged to read through the entire readme before attempting to do this lab!

You are the lead software engineer for a manufacturer that makes cash registers. Clients (e.g. Target, Walmart, Macys, Whole Foods) generally want to be able to program their cash registers after the fact to use their own receipt formats and program items into the register such that the pricing rules can change periodically (e.g. couponing, taxes, etc.)

As the manufacturer you do NOT want the Retailer to modify the cash register code itself, so you decide you are going to give them blocks as arguments for the methods that build the format of each transaction on the receipt so that they do not have to change anything in the register library itself.

The corporate office of a retailer will then program the logic for all the registers remotely, and each register will be assigned a store (which has a location, e.g. New York, New Jersey, Connecticut). Each store has just one register which logs all customer transactions.

To speed this process up a little, your junior developer has provided you with a basic Product, Transaction, Store and State class, complete with properties and initializers where needed.

As senior developer, you have to do the heavy lifting of the blocks. Ha. Ha. Ha.

Here is what you will need to do:

1. Build a CashRegister class with four properties including:

@property (strong, nonatomic) Store *store;

@property (strong, nonatomic) NSArray *transactions;

as well as two block properties. Since this is a lab on blocks, we'll let you figure out how to write those up. You'll want one for couponLogic and another for taxLogic.

This class will also have two methods called applyCoupons and calculateTax. They will both return an NSNumber for the total dollars saved by using coupons and the total amount of tax for all transactions on the CashRegister respectively.

2. A test suite, which we have started for you. (Expected student response: Test practice too? Yes!!!)

The test suite should use the logic blocks for taxLogic and couponLogic provided below to ensure that your CashRegister object is working as expected. You will also need some test data, so we have included some code for you to cut and paste where appropriate in the test suite. We have also left you some hints on what to do in the test suite in the form of comments. But make sure you understand why you are placing the code in various places within the test suite!

If you've done it correctly, you will be given the total savings from coupons and the total tax collected of all transactions from each store, as the expect statements suggest.

####Tax Logic

        NSNumber *taxAmount = @([transaction.product.price floatValue] * [cashRegister.store.state.taxRate floatValue]);
        
        NSCalendar *calendar = [[NSCalendar alloc] initWithCalendarIdentifier:NSCalendarIdentifierGregorian];
        
        NSDateComponents *components = [[NSDateComponents alloc] init];
        
        switch (transaction.product.productCategory) {
            case ProductCategoryGrocery:
                
                return @0;
                
            case ProductCategoryApparel:
                
                if ([cashRegister.store.state.abbreviation isEqualToString:@"NY"] &&  [transaction.product.price floatValue]  < 100)
                {
                    return @0;
                }
                
                return taxAmount;
                
            case ProductCategoryEducation:
            {
                components.calendar = calendar;
                components.year = 2014;
                components.month = 8;
                components.day = 1;
                components.hour = 0;
                components.minute = 0;
                components.second = 0;
                
                NSDate *startOfSchoolShoppingSeason = [calendar dateFromComponents:components];
                
                components.calendar = calendar;
                components.year = 2014;
                components.month = 9;
                components.day = 30;
                components.hour = 23;
                components.minute = 59;
                components.second = 59;
                
                NSDate *endOfSchoolShoppingSeason = [calendar dateFromComponents:components];
                
                if (([transaction.dateOfTransaction compare:startOfSchoolShoppingSeason] == NSOrderedAscending) && ([transaction.dateOfTransaction compare:endOfSchoolShoppingSeason] == NSOrderedDescending)) {
                    return @0;
                }
                
                return taxAmount;
            
        }
            case ProductCategoryLuxuryItem:
                
                return @([taxAmount floatValue] * 2);
                
            default:
                return taxAmount;
        }
        
        return nil;

####Coupon Logic

        if ([transaction.fullTransactionValue floatValue] > 10.0 && transaction.product.productCategory != ProductCategoryEducation)
        {
            return (@([transaction.fullTransactionValue floatValue] * .10));
        }
        else
            return @0;

####Transaction Data Code

    
    Product *apple = [[Product alloc] initWithProductDescription:@"Granny Smith" UPC:@"0000000000415" Price:@0.95  Size:@1 Measure:@"ea" andProductCategory:ProductCategoryGrocery];
    
    Product *cereal = [[Product alloc] initWithProductDescription:@"Cracklin' Oat Bran" UPC:@"0038000045301" Price:@4.99 Size:@17 Measure:@"oz" andProductCategory:ProductCategoryGrocery];
    
    Product *vanillaGoGurt = [[Product alloc] initWithProductDescription:@"Vanilla GoGurt - To Stay, 7 oz" UPC:@"0038000045301" Price:@1.99 Size:@17 Measure:@"oz" andProductCategory:ProductCategoryGrocery];
    
    Product *sliceSoda = [[Product alloc] initWithProductDescription:@"That soda that you've probably heard of was once a competitor to Sprite" UPC:@"12000810060" Price:@1.99 Size:@67.628 Measure:@"fl oz" andProductCategory:ProductCategoryGrocery];
    
    Product *siliconValleyHoodie = [[Product alloc] initWithProductDescription:@"Silicon Valley Hoodie - Size M" UPC:@"55000030387" Price:@42.99 Size:@2 Measure:@"Mens Tee" andProductCategory:ProductCategoryApparel];
    
    Product *functionalProgrammingWithSwiftBook = [[Product alloc] initWithProductDescription:@"Functional Programming in Swift" UPC:@"66611000000" Price:@29.99 Size:@417 Measure:@"pages" andProductCategory:ProductCategoryEducation];

    
    NSCalendar *calendar = [[NSCalendar alloc]
                            initWithCalendarIdentifier:NSCalendarIdentifierGregorian];
    NSDateComponents *components = [[NSDateComponents alloc] init];
    components.calendar = calendar;
    components.year = 2014;
    components.month = 5;
    components.day = 12;
    components.hour = 16;
    components.minute = 1;
    components.second = 12;
    
    NSDate *date1 = [calendar dateFromComponents:components];
    
    Transaction *transactionOne = [[Transaction alloc] initWithProduct:apple Quantity:@25 Date:date1];
    
    components.year = 2014;
    components.month = 9;
    components.day = 15;
    components.hour = 2;
    components.minute = 22;
    components.second = 43;
    NSDate *date2 = [calendar dateFromComponents:components];

    Transaction *transactionTwo = [[Transaction alloc] initWithProduct:cereal Quantity:@14 Date:date2];

    components.year = 2014;
    components.month = 6;
    components.day = 12;
    components.hour = 12;
    components.minute = 0;
    components.second = 1;
    NSDate *date3 = [calendar dateFromComponents:components];

    Transaction *transactionThree = [[Transaction alloc] initWithProduct:vanillaGoGurt Quantity:@5 Date:date3];
    
    components.year = 2014;
    components.month = 6;
    components.day = 12;
    components.hour = 12;
    components.minute = 0;
    components.second = 1;
    NSDate *date4 = [calendar dateFromComponents:components];
    
    Transaction *transactionFour = [[Transaction alloc] initWithProduct:sliceSoda Quantity:@1 Date:date4];

    components.year = 2014;
    components.month = 6;
    components.day = 12;
    components.hour = 12;
    components.minute = 0;
    components.second = 4;
    NSDate *date5 = [calendar dateFromComponents:components];
    
    Transaction *transactionFive = [[Transaction alloc] initWithProduct:siliconValleyHoodie Quantity:@1 Date:date5];
    
    components.year = 2014;
    components.month = 6;
    components.day = 12;
    components.hour = 12;
    components.minute = 0;
    components.second = 10;
    NSDate *date6 = [calendar dateFromComponents:components];
    
    Transaction *transactionSix = [[Transaction alloc] initWithProduct:functionalProgrammingWithSwiftBook Quantity:@1 Date:date6];

Advanced

Google "how to compile a static library in Objective-C", to ensure you know how to keep your end user from modifying your lovely code base! Commit before compiling.

Notes

• Enums are used here to give numeric values more meaning. Therefore instead of using the number "1" to mean a product in the apparel category, we can use ProductCategoryApparel instead. For more information, check out this article) on the various ways to declare ENUM. (You can find our declaration of it in the Product.h file.)

• Check out the "switch" statements in our tax and coupon logic. They take the place of "if" statements as a conditional.

• In a real life scenario, we would likely have an array of products and their quantities as part of the Transaction object; but for today, we've chosen to simplify a bit for the sake of getting to the real point of this lab, which is blocks!

• In our contrived example, the tax gets applied to the items gross price (i.e. before the coupon discount gets applied). Feel free to try to get fancy and make them work together if you get this far!