RestKit/Tests/Logic/CoreData/RKEntityCacheTest.m

//
//  RKEntityCacheTest.m
//  RestKit
//
//  Created by Blake Watters on 5/2/12.
//  Copyright (c) 2012 RestKit. All rights reserved.
//

#import "RKTestEnvironment.h"
#import "NSEntityDescription+RKAdditions.h"
#import "RKEntityCache.h"
#import "RKEntityByAttributeCache.h"
#import "RKHuman.h"

@interface RKEntityCacheTest : RKTestCase
@property (nonatomic, retain) RKManagedObjectStore *managedObjectStore;
@property (nonatomic, retain) RKEntityCache *cache;
@property (nonatomic, retain) NSEntityDescription *entity;
@end

@implementation RKEntityCacheTest

@synthesize managedObjectStore = _managedObjectStore;
@synthesize cache = _cache;
@synthesize entity = _entity;

- (void)setUp
{
    [RKTestFactory setUp];

    self.managedObjectStore = [RKTestFactory managedObjectStore];
    _cache = [[RKEntityCache alloc] initWithManagedObjectContext:self.managedObjectStore.primaryManagedObjectContext];
    self.entity = [NSEntityDescription entityForName:@"RKHuman" inManagedObjectContext:self.managedObjectStore.primaryManagedObjectContext];
}

- (void)tearDown
{
    self.managedObjectStore = nil;
    self.cache = nil;

    [RKTestFactory tearDown];
}

- (void)testInitializationSetsManagedObjectContext
{
    assertThat(_cache.managedObjectContext, is(equalTo(self.managedObjectStore.primaryManagedObjectContext)));
}

- (void)testIsEntityCachedByAttribute
{
    assertThatBool([_cache isEntity:self.entity cachedByAttribute:@"railsID"], is(equalToBool(NO)));
    [_cache cacheObjectsForEntity:self.entity byAttribute:@"railsID"];
    assertThatBool([_cache isEntity:self.entity cachedByAttribute:@"railsID"], is(equalToBool(YES)));
}

- (void)testRetrievalOfUnderlyingEntityAttributeCache
{
    [_cache cacheObjectsForEntity:self.entity byAttribute:@"railsID"];
    RKEntityByAttributeCache *attributeCache = [_cache attributeCacheForEntity:self.entity attribute:@"railsID"];
    assertThat(attributeCache, is(notNilValue()));
}

- (void)testRetrievalOfUnderlyingEntityAttributeCaches
{
    [_cache cacheObjectsForEntity:self.entity byAttribute:@"railsID"];
    NSArray *caches = [_cache attributeCachesForEntity:self.entity];
    assertThat(caches, is(notNilValue()));
    assertThatInteger([caches count], is(equalToInteger(1)));
}

- (void)testRetrievalOfObjectForEntityWithAttributeValue
{
    RKHuman *human = [NSEntityDescription insertNewObjectForEntityForName:@"RKHuman" inManagedObjectContext:self.managedObjectStore.primaryManagedObjectContext];
    human.railsID = [NSNumber numberWithInteger:12345];
    NSError *error = nil;
    [self.managedObjectStore.primaryManagedObjectContext save:&error];

    [_cache cacheObjectsForEntity:self.entity byAttribute:@"railsID"];
    NSManagedObjectContext *childContext = [[[NSManagedObjectContext alloc] initWithConcurrencyType:NSPrivateQueueConcurrencyType] autorelease];
    childContext.parentContext = self.managedObjectStore.primaryManagedObjectContext;
    NSManagedObject *fetchedObject = [self.cache objectForEntity:self.entity withAttribute:@"railsID" value:[NSNumber numberWithInteger:12345] inContext:childContext];
    assertThat(fetchedObject, is(notNilValue()));
}

- (void)testRetrievalOfObjectsForEntityWithAttributeValue
{
    RKHuman *human1 = [NSEntityDescription insertNewObjectForEntityForName:@"RKHuman" inManagedObjectContext:self.managedObjectStore.primaryManagedObjectContext];
    human1.railsID = [NSNumber numberWithInteger:12345];
    RKHuman *human2 = [NSEntityDescription insertNewObjectForEntityForName:@"RKHuman" inManagedObjectContext:self.managedObjectStore.primaryManagedObjectContext];
    human2.railsID = [NSNumber numberWithInteger:12345];
    NSError *error = nil;
    [self.managedObjectStore.primaryManagedObjectContext save:&error];

    [_cache cacheObjectsForEntity:self.entity byAttribute:@"railsID"];
    NSManagedObjectContext *childContext = [[[NSManagedObjectContext alloc] initWithConcurrencyType:NSPrivateQueueConcurrencyType] autorelease];
    childContext.parentContext = self.managedObjectStore.primaryManagedObjectContext;
    NSArray *objects = [self.cache objectsForEntity:self.entity withAttribute:@"railsID" value:[NSNumber numberWithInteger:12345] inContext:childContext];
    assertThat(objects, hasCountOf(2));
    assertThat([objects valueForKey:@"objectID"], containsInAnyOrder(human1.objectID, human2.objectID, nil));
}

- (void)testThatFlushEmptiesAllUnderlyingAttributeCaches
{
    RKHuman *human1 = [NSEntityDescription insertNewObjectForEntityForName:@"RKHuman" inManagedObjectContext:self.managedObjectStore.primaryManagedObjectContext];
    human1.railsID = [NSNumber numberWithInteger:12345];
    human1.name = @"Blake";
    RKHuman *human2 = [NSEntityDescription insertNewObjectForEntityForName:@"RKHuman" inManagedObjectContext:self.managedObjectStore.primaryManagedObjectContext];
    human2.railsID = [NSNumber numberWithInteger:12345];
    human2.name = @"Sarah";

    [self.managedObjectStore.primaryManagedObjectContext save:nil];
    [_cache cacheObjectsForEntity:self.entity byAttribute:@"railsID"];
    [_cache cacheObjectsForEntity:self.entity byAttribute:@"name"];
    
    NSManagedObjectContext *childContext = [[[NSManagedObjectContext alloc] initWithConcurrencyType:NSPrivateQueueConcurrencyType] autorelease];
    childContext.parentContext = self.managedObjectStore.primaryManagedObjectContext;

    NSArray *objects = [self.cache objectsForEntity:self.entity withAttribute:@"railsID" value:[NSNumber numberWithInteger:12345] inContext:childContext];
    assertThat(objects, hasCountOf(2));
    assertThat([objects valueForKey:@"objectID"], containsInAnyOrder(human1.objectID, human2.objectID, nil));

    objects = [self.cache objectsForEntity:self.entity withAttribute:@"name" value:@"Blake" inContext:childContext];
    assertThat(objects, hasCountOf(1));
    assertThat([objects valueForKey:@"objectID"], contains(human1.objectID, nil));

    [self.cache flush];
    objects = [self.cache objectsForEntity:self.entity withAttribute:@"railsID" value:[NSNumber numberWithInteger:12345] inContext:childContext];
    assertThat(objects, is(empty()));
    objects = [self.cache objectsForEntity:self.entity withAttribute:@"name" value:@"Blake" inContext:childContext];
    assertThat(objects, is(empty()));
}

- (void)testAddingObjectAddsToEachUnderlyingEntityAttributeCaches
{
    [_cache cacheObjectsForEntity:self.entity byAttribute:@"railsID"];
    [_cache cacheObjectsForEntity:self.entity byAttribute:@"name"];

    RKHuman *human1 = [NSEntityDescription insertNewObjectForEntityForName:@"RKHuman" inManagedObjectContext:self.managedObjectStore.primaryManagedObjectContext];
    human1.railsID = [NSNumber numberWithInteger:12345];
    human1.name = @"Blake";
    RKHuman *human2 = [NSEntityDescription insertNewObjectForEntityForName:@"RKHuman" inManagedObjectContext:self.managedObjectStore.primaryManagedObjectContext];
    human2.railsID = [NSNumber numberWithInteger:12345];
    human2.name = @"Sarah";
    
    __block NSError *error;
    __block BOOL success;
    [self.managedObjectStore.primaryManagedObjectContext performBlockAndWait:^{
        success = [self.managedObjectStore.primaryManagedObjectContext save:&error];
    }];
    assertThatBool(success, is(equalToBool(YES)));
    
    [_cache addObject:human1];
    [_cache addObject:human2];
    
    NSManagedObjectContext *childContext = [[[NSManagedObjectContext alloc] initWithConcurrencyType:NSPrivateQueueConcurrencyType] autorelease];
    childContext.parentContext = self.managedObjectStore.primaryManagedObjectContext;

    NSArray *objects = [self.cache objectsForEntity:self.entity withAttribute:@"railsID" value:[NSNumber numberWithInteger:12345] inContext:childContext];
    assertThat(objects, hasCountOf(2));
    assertThat([objects valueForKey:@"objectID"], containsInAnyOrder(human1.objectID, human2.objectID, nil));

    objects = [self.cache objectsForEntity:self.entity withAttribute:@"name" value:@"Blake" inContext:childContext];
    assertThat(objects, hasCountOf(1));
    assertThat([objects  valueForKey:@"objectID"], contains(human1.objectID, nil));
}

- (void)testRemovingObjectRemovesFromUnderlyingEntityAttributeCaches
{
    [_cache cacheObjectsForEntity:self.entity byAttribute:@"railsID"];
    [_cache cacheObjectsForEntity:self.entity byAttribute:@"name"];

    RKHuman *human1 = [NSEntityDescription insertNewObjectForEntityForName:@"RKHuman" inManagedObjectContext:self.managedObjectStore.primaryManagedObjectContext];
    human1.railsID = [NSNumber numberWithInteger:12345];
    human1.name = @"Blake";
    RKHuman *human2 = [NSEntityDescription insertNewObjectForEntityForName:@"RKHuman" inManagedObjectContext:self.managedObjectStore.primaryManagedObjectContext];
    human2.railsID = [NSNumber numberWithInteger:12345];
    human2.name = @"Sarah";
    
    __block NSError *error;
    __block BOOL success;
    [self.managedObjectStore.primaryManagedObjectContext performBlockAndWait:^{
        success = [self.managedObjectStore.primaryManagedObjectContext save:&error];
    }];
    assertThatBool(success, is(equalToBool(YES)));
    
    [_cache addObject:human1];
    [_cache addObject:human2];
    
    NSManagedObjectContext *childContext = [[[NSManagedObjectContext alloc] initWithConcurrencyType:NSPrivateQueueConcurrencyType] autorelease];
    childContext.parentContext = self.managedObjectStore.primaryManagedObjectContext;

    NSArray *objects = [self.cache objectsForEntity:self.entity withAttribute:@"railsID" value:[NSNumber numberWithInteger:12345] inContext:childContext];
    assertThat(objects, hasCountOf(2));
    assertThat([objects valueForKey:@"objectID"], containsInAnyOrder(human1.objectID, human2.objectID, nil));

    RKEntityByAttributeCache *entityAttributeCache = [self.cache attributeCacheForEntity:self.entity attribute:@"railsID"];
    assertThatBool([entityAttributeCache containsObject:human1], is(equalToBool(YES)));
    [self.cache removeObject:human1];
    assertThatBool([entityAttributeCache containsObject:human1], is(equalToBool(NO)));
}

@end