Merging changes from PR TumblrArchive#30 and PR TumblrArchive#37 from their respective forks

Daryll Herberger · Daryll Herberger · commit a1cc0955bfed · 2014-04-10T10:43:46.000-07:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+### 1.3.0 -- 2013 XXXX ###
+
+- [new] TMDiskCache: introduced concept of "trash" for rapid wipeouts
+
+
 ### 1.2.0 -- 2013 May 24 ###
 
 - [new] TMDiskCache: added method `enumerateObjectsWithBlock:completionBlock:`
diff --git a/README.md b/README.md
@@ -7,8 +7,8 @@
 `TMCache` and `TMDiskCache` accept any object conforming to [NSCoding](https://developer.apple.com/library/ios/#documentation/Cocoa/Reference/Foundation/Protocols/NSCoding_Protocol/Reference/Reference.html). Put things in like this:
 
 ```objective-c
-UIImage *image = [[UIImage alloc] initWithData:data scale:[[UIScreen mainScreen] scale]];
-[[TMCache sharedCache] setObject:image forKey:@"image" block:nil]; // returns immediately
+UIImage *img = [[UIImage alloc] initWithData:data scale:[[UIScreen mainScreen] scale]];
+[[TMCache sharedCache] setObject:img forKey:@"image" block:nil]; // returns immediately
 ```
     
 Get them back out like this:
@@ -28,7 +28,7 @@ Collections work too. Thanks to the magic of `NSKeyedArchiver`, objects repeated
 ```objective-c
 NSArray *images = @[ image, image, image ];
 [[TMCache sharedCache] setObject:images forKey:@"images"];
-NSLog(@"three for the price of one: %d", [[[TMCache sharedCache] diskCache] byteCount]);
+NSLog(@"3 for the price of 1: %d", [[[TMCache sharedCache] diskCache] byteCount]);
 ```
 
 ## Installation  ##
diff --git a/TMCache/TMCache.m b/TMCache/TMCache.m
@@ -131,7 +131,7 @@ - (void)objectForKey:(NSString *)key readBlock:(TMCacheReadBlock)readBlock block
 
 - (void)setObject:(id <NSCoding>)object forKey:(NSString *)key block:(TMCacheObjectBlock)block
 {
-    return [self setObject:object forKey:key writeBlock:NULL block:block];
+    [self setObject:object forKey:key writeBlock:NULL block:block];
 }
 
 - (void)setObject:(id)object forKey:(NSString *)key writeBlock:(TMCacheWriteBlock)writeBlock block:(TMCacheObjectBlock)block
@@ -329,22 +329,26 @@ - (id)objectForKey:(NSString *)key readBlock:(TMCacheReadBlock)readBlock
     if (!key)
         return nil;
     
-    __block id objectForKey = nil;
-
-    dispatch_semaphore_t semaphore = dispatch_semaphore_create(0);
-
-    [self objectForKey:key readBlock:readBlock block:^(TMCache *cache, NSString *key, id object) {
-        objectForKey = object;
-        dispatch_semaphore_signal(semaphore);
-    }];
-
-    dispatch_semaphore_wait(semaphore, DISPATCH_TIME_FOREVER);
-
-    #if !OS_OBJECT_USE_OBJC
-    dispatch_release(semaphore);
-    #endif
-
-    return objectForKey;
+    id object = [_memoryCache objectForKey:key];
+    
+    if (object) {
+        __weak TMCache *weakSelf = self;
+        dispatch_barrier_async(_queue, ^{
+            TMCache *strongSelf = weakSelf;
+            if (strongSelf)
+                [strongSelf->_diskCache fileURLForKey:key block:^(TMDiskCache *cache, NSString *key, id <NSCoding> object, NSURL *fileURL) {
+                    // update the access time on disk
+                }];
+        });
+    } else {
+        object = [_diskCache objectForKey:key];
+        
+        if (object) {
+            [_memoryCache setObject:object forKey:key block:nil];
+        }
+    };
+    
+    return object;
 }
 
 - (void)setObject:(id <NSCoding>)object forKey:(NSString *)key
@@ -423,4 +427,4 @@ - (void)removeAllObjects
 
 @end
 
-#pragma HC SVNT DRACONES
+// HC SVNT DRACONES
diff --git a/TMCache/TMDiskCache.h b/TMCache/TMDiskCache.h
@@ -134,6 +134,12 @@ typedef id (^TMDiskCacheReadBlock)(TMDiskCache *cache, NSString *key, NSURL *fil
  */
 + (dispatch_queue_t)sharedQueue;
 
+/**
+ Empties the trash with `DISPATCH_QUEUE_PRIORITY_BACKGROUND`. Does not block the <sharedQueue>.
+ */
++ (void)emptyTrash;
+
+
 /**
  The designated initializer. Multiple instances with the same name are allowed and can safely access
  the same data on disk thanks to the magic of seriality.
diff --git a/TMCache/TMDiskCache.m b/TMCache/TMDiskCache.m
@@ -150,6 +150,80 @@ - (NSString *)decodedString:(NSString *)string
     return (__bridge_transfer NSString *)unescapedString;
 }
 
+#pragma mark - Private Trash Methods -
+
++ (dispatch_queue_t)sharedTrashQueue
+{
+    static dispatch_queue_t trashQueue;
+    static dispatch_once_t predicate;
+    
+    dispatch_once(&predicate, ^{
+        NSString *queueName = [[NSString alloc] initWithFormat:@"%@.trash", TMDiskCachePrefix];
+        trashQueue = dispatch_queue_create([queueName UTF8String], DISPATCH_QUEUE_SERIAL);
+        dispatch_set_target_queue(trashQueue, dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_BACKGROUND, 0));
+    });
+    
+    return trashQueue;
+}
+
++ (NSURL *)sharedTrashURL
+{
+    static NSURL *sharedTrashURL;
+    static dispatch_once_t predicate;
+    
+    dispatch_once(&predicate, ^{
+        sharedTrashURL = [[[NSURL alloc] initFileURLWithPath:NSTemporaryDirectory()] URLByAppendingPathComponent:TMDiskCachePrefix isDirectory:YES];
+        
+        dispatch_async([self sharedTrashQueue], ^{
+            if (![[NSFileManager defaultManager] fileExistsAtPath:[sharedTrashURL path]]) {
+                NSError *error = nil;
+                [[NSFileManager defaultManager] createDirectoryAtURL:sharedTrashURL
+                                         withIntermediateDirectories:YES
+                                                          attributes:nil
+                                                               error:&error];
+                TMDiskCacheError(error);
+            }
+        });
+    });
+    
+    return sharedTrashURL;
+}
+
++(BOOL)moveItemAtURLToTrash:(NSURL *)itemURL
+{
+    if (![[NSFileManager defaultManager] fileExistsAtPath:[itemURL path]])
+        return NO;
+
+    NSError *error = nil;
+    NSString *uniqueString = [[NSProcessInfo processInfo] globallyUniqueString];
+    NSURL *uniqueTrashURL = [[TMDiskCache sharedTrashURL] URLByAppendingPathComponent:uniqueString];
+    BOOL moved = [[NSFileManager defaultManager] moveItemAtURL:itemURL toURL:uniqueTrashURL error:&error];
+    TMDiskCacheError(error);
+    return moved;
+}
+
++ (void)emptyTrash
+{
+    TMCacheStartBackgroundTask();
+    
+    dispatch_async([self sharedTrashQueue], ^{        
+        NSError *error = nil;
+        NSArray *trashedItems = [[NSFileManager defaultManager] contentsOfDirectoryAtURL:[self sharedTrashURL]
+                                                              includingPropertiesForKeys:nil
+                                                                                 options:0
+                                                                                   error:&error];
+        TMDiskCacheError(error);
+
+        for (NSURL *trashedItemURL in trashedItems) {
+            NSError *error = nil;
+            [[NSFileManager defaultManager] removeItemAtURL:trashedItemURL error:&error];
+            TMDiskCacheError(error);
+        }
+            
+        TMCacheEndBackgroundTask();
+    });
+}
+
 #pragma mark - Private Queue Methods -
 
 - (BOOL)createCacheDirectory
@@ -224,12 +298,11 @@ - (BOOL)removeFileAndExecuteBlocksForKey:(NSString *)key
     if (_willRemoveObjectBlock)
         _willRemoveObjectBlock(self, key, nil, fileURL);
 
-    NSError *error = nil;
-    BOOL removed = [[NSFileManager defaultManager] removeItemAtURL:fileURL error:&error];
-    TMDiskCacheError(error);
-
-    if (!removed)
+    BOOL trashed = [TMDiskCache moveItemAtURLToTrash:fileURL];
+    if (!trashed)
         return NO;
+    
+    [TMDiskCache emptyTrash];
 
     NSNumber *byteSize = [_sizes objectForKey:key];
     if (byteSize)
@@ -409,7 +482,7 @@ - (void)setObject:(id)object forKey:(NSString *)key writeBlock:(TMDiskCacheWrite
         if (written) {
             [strongSelf setFileModificationDate:now forURL:fileURL];
 
-            error = nil;
+            NSError *error = nil;
             NSDictionary *values = [fileURL resourceValuesForKeys:@[ NSURLTotalFileAllocatedSizeKey ] error:&error];
             TMDiskCacheError(error);
 
@@ -560,12 +633,9 @@ - (void)removeAllObjects:(TMDiskCacheBlock)block
 
         if (strongSelf->_willRemoveAllObjectsBlock)
             strongSelf->_willRemoveAllObjectsBlock(strongSelf);
-
-        if ([[NSFileManager defaultManager] fileExistsAtPath:[strongSelf->_cacheURL path]]) {
-            NSError *error = nil;
-            [[NSFileManager defaultManager] removeItemAtURL:strongSelf->_cacheURL error:&error];
-            TMDiskCacheError(error);
-        }
+        
+        [TMDiskCache moveItemAtURLToTrash:strongSelf->_cacheURL];
+        [TMDiskCache emptyTrash];
 
         [strongSelf createCacheDirectory];
 
@@ -624,23 +694,22 @@ - (id)objectForKey:(NSString *)key readBlock:(TMDiskCacheReadBlock)readBlock
 {
     if (!key)
         return nil;
-
-    __block id <NSCoding> objectForKey = nil;
-
-    dispatch_semaphore_t semaphore = dispatch_semaphore_create(0);
-
-    [self objectForKey:key readBlock:readBlock block:^(TMDiskCache *cache, NSString *key, id <NSCoding> object, NSURL *fileURL) {
-        objectForKey = object;
-        dispatch_semaphore_signal(semaphore);
-    }];
     
-    dispatch_semaphore_wait(semaphore, DISPATCH_TIME_FOREVER);
-
-    #if !OS_OBJECT_USE_OBJC
-    dispatch_release(semaphore);
-    #endif
-
-    return objectForKey;
+    NSURL *fileURL = [self encodedFileURLForKey:key];
+    
+    // No need to check if file exists, as unarchiveObjectWithFile returns nil if there is no file at path
+    id <NSCoding> object = [NSKeyedUnarchiver unarchiveObjectWithFile:[fileURL path]];
+    
+    if (object) {
+        __weak TMDiskCache *weakSelf = self;
+        dispatch_barrier_async(_queue, ^{
+            TMDiskCache *strongSelf = weakSelf;
+            if (strongSelf)
+                [strongSelf setFileModificationDate:[NSDate new] forURL:fileURL];
+        });
+    }
+    
+    return object;
 }
 
 - (NSURL *)fileURLForKey:(NSString *)key
diff --git a/TMCache/TMMemoryCache.m b/TMCache/TMMemoryCache.m
@@ -225,8 +225,6 @@ - (void)trimToAgeLimitRecursively
 
 - (void)objectForKey:(NSString *)key block:(TMMemoryCacheObjectBlock)block
 {
-    NSDate *now = [[NSDate alloc] init];
-    
     if (!key || !block)
         return;
 
@@ -237,18 +235,7 @@ - (void)objectForKey:(NSString *)key block:(TMMemoryCacheObjectBlock)block
         if (!strongSelf)
             return;
 
-        id object = [strongSelf->_dictionary objectForKey:key];
-
-        if (object) {
-            __weak TMMemoryCache *weakSelf = strongSelf;
-            dispatch_barrier_async(strongSelf->_queue, ^{
-                TMMemoryCache *strongSelf = weakSelf;
-                if (strongSelf)
-                    [strongSelf->_dates setObject:now forKey:key];
-            });
-        }
-
-        block(strongSelf, key, object);
+        block(strongSelf, key, [strongSelf objectForKey:key]);
     });
 }
 
@@ -463,23 +450,19 @@ - (id)objectForKey:(NSString *)key
 {
     if (!key)
         return nil;
-
-    __block id objectForKey = nil;
-
-    dispatch_semaphore_t semaphore = dispatch_semaphore_create(0);
-
-    [self objectForKey:key block:^(TMMemoryCache *cache, NSString *key, id object) {
-        objectForKey = object;
-        dispatch_semaphore_signal(semaphore);
-    }];
-
-    dispatch_semaphore_wait(semaphore, DISPATCH_TIME_FOREVER);
-
-    #if !OS_OBJECT_USE_OBJC
-    dispatch_release(semaphore);
-    #endif
-
-    return objectForKey;
+    
+    id object = [_dictionary objectForKey:key];
+    
+    if (object) {
+        __weak TMMemoryCache *weakSelf = self;
+        dispatch_barrier_async(_queue, ^{
+            TMMemoryCache *strongSelf = weakSelf;
+            if (strongSelf)
+                [strongSelf->_dates setObject:[NSDate new] forKey:key];
+        });
+    }
+    
+    return object;
 }
 
 - (void)setObject:(id)object forKey:(NSString *)key
diff --git a/build_tests.sh b/build_tests.sh
@@ -1,3 +1,3 @@
 #!/usr/bin/env sh
 
-xcodebuild -project tests/TMCache.xcodeproj -scheme TMCacheTests -sdk iphonesimulator TEST_AFTER_BUILD=YES clean build
+xcodebuild ONLY_ACTIVE_ARCH=NO -project tests/TMCache.xcodeproj -scheme TMCacheTests -sdk iphonesimulator TEST_AFTER_BUILD=YES clean build
diff --git a/tests/TMCache.xcodeproj/project.pbxproj b/tests/TMCache.xcodeproj/project.pbxproj
@@ -211,7 +211,7 @@
 			isa = PBXProject;
 			attributes = {
 				CLASSPREFIX = TM;
-				LastUpgradeCheck = 0460;
+				LastUpgradeCheck = 0500;
 				ORGANIZATIONNAME = Tumblr;
 			};
 			buildConfigurationList = D07F1EAD171AFB7A001DBA02 /* Build configuration list for PBXProject "TMCache" */;
@@ -329,7 +329,7 @@
 				GCC_WARN_UNINITIALIZED_AUTOS = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
 				IPHONEOS_DEPLOYMENT_TARGET = 6.1;
-				ONLY_ACTIVE_ARCH = NO;
+				ONLY_ACTIVE_ARCH = YES;
 				SDKROOT = iphoneos;
 				TARGETED_DEVICE_FAMILY = "1,2";
 			};
@@ -402,6 +402,7 @@
 				INFOPLIST_FILE = "TMCacheTests/TMCacheTests-Info.plist";
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				TEST_HOST = "$(BUNDLE_LOADER)";
+				VALID_ARCHS = "arm64 armv7 armv7s i386 x86_64";
 				WRAPPER_EXTENSION = octest;
 			};
 			name = Debug;
@@ -419,6 +420,7 @@
 				INFOPLIST_FILE = "TMCacheTests/TMCacheTests-Info.plist";
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				TEST_HOST = "$(BUNDLE_LOADER)";
+				VALID_ARCHS = "arm64 armv7 armv7s i386 x86_64";
 				WRAPPER_EXTENSION = octest;
 			};
 			name = Release;
diff --git a/tests/TMCache.xcodeproj/xcshareddata/xcschemes/TMCacheTests.xcscheme b/tests/TMCache.xcodeproj/xcshareddata/xcschemes/TMCacheTests.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0460"
+   LastUpgradeVersion = "0500"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`#!/usr/bin/env sh`
`2`	`2`
`3`		`-xcodebuild -project tests/TMCache.xcodeproj -scheme TMCacheTests -sdk iphonesimulator TEST_AFTER_BUILD=YES clean build`
	`3`	`+xcodebuild ONLY_ACTIVE_ARCH=NO -project tests/TMCache.xcodeproj -scheme TMCacheTests -sdk iphonesimulator TEST_AFTER_BUILD=YES clean build`