Implement NSArray writeToURL and initWithContentsOfURL (microsoft#2218)

Implement [NSArray writeToURL:atomically:], [NSArray arrayWithContentsOfURL:], and [NSArray initWithContentsOfURL:].

Fixes microsoft#2069

Author: aballway

Frameworks/Foundation/NSArray.mm

@@ -37,6 +37,8 @@
 
 static const wchar_t* TAG = L"NSArray";
 
+static const CFPropertyListFormat sc_plistFormat = kCFPropertyListBinaryFormat_v1_0;
+
 @implementation NSArray
 
 BASE_CLASS_REQUIRED_IMPLS(NSArray, NSArrayPrototype, CFArrayGetTypeID);
@@ -809,16 +811,14 @@ - (void)enumerateObjectsWithOptions:(NSEnumerationOptions)options usingBlock:(vo
         reverse = false;
     }
 
-    _enumerateWithBlock(enumerator,
-                        options,
-                        ^(id key, BOOL* stop) {
-                            block(key, index, stop);
-                            if (reverse) {
-                                index--;
-                            } else {
-                                index++;
-                            }
-                        });
+    _enumerateWithBlock(enumerator, options, ^(id key, BOOL* stop) {
+        block(key, index, stop);
+        if (reverse) {
+            index--;
+        } else {
+            index++;
+        }
+    });
 }
 
 /**
@@ -915,10 +915,10 @@ - (NSArray*)objectsAtIndexes:(NSIndexSet*)indexes {
  @Notes
 */
 - (void)addObserver:(NSObject*)anObserver
- toObjectsAtIndexes:(NSIndexSet*)indexes
-         forKeyPath:(NSString*)keyPath
-            options:(NSKeyValueObservingOptions)options
-            context:(void*)context {
+    toObjectsAtIndexes:(NSIndexSet*)indexes
+            forKeyPath:(NSString*)keyPath
+               options:(NSKeyValueObservingOptions)options
+               context:(void*)context {
     UNIMPLEMENTED();
 }
 
@@ -939,12 +939,11 @@ - (void)removeObserver:(NSObject*)observer fromObjectsAtIndexes:(NSIndexSet*)ind
 }
 
 /**
- @Status Stub
+ @Status Interoperable
  @Notes
 */
 + (NSArray*)arrayWithContentsOfURL:(NSURL*)aURL {
-    UNIMPLEMENTED();
-    return StubReturn();
+    return [[[self alloc] initWithContentsOfURL:aURL] autorelease];
 }
 
 /**
@@ -996,21 +995,29 @@ - (NSIndexSet*)indexesOfObjectsAtIndexes:(NSIndexSet*)indexSet
 }
 
 /**
- @Status Stub
+ @Status Interoperable
  @Notes
 */
 - (NSArray*)initWithContentsOfURL:(NSURL*)aURL {
-    UNIMPLEMENTED();
-    return StubReturn();
+    NSData* data = [NSData dataWithContentsOfURL:aURL];
+    return static_cast<NSArray*>(
+        CFPropertyListCreateWithData(nullptr, static_cast<CFDataRef>(data), kCFPropertyListImmutable, nullptr, nullptr));
 }
 
 /**
- @Status Stub
- @Notes
+ @Status Caveat
+ @Notes Only file:// URLs supported. atomically parameter not supported.
 */
 - (BOOL)writeToURL:(NSURL*)aURL atomically:(BOOL)flag {
-    UNIMPLEMENTED();
-    return StubReturn();
+    CFPropertyListRef plist = static_cast<CFPropertyListRef>(self);
+    if (CFPropertyListIsValid(plist, sc_plistFormat)) {
+        auto data = woc::AutoCF<CFDataRef>(CFPropertyListCreateData(nullptr, plist, sc_plistFormat, 0, nullptr));
+        if (data) {
+            return [static_cast<NSData*>(data.get()) writeToURL:aURL atomically:flag];
+        }
+    }
+
+    return NO;
 }
 
 /**

include/Foundation/NSArray.h

@@ -42,14 +42,14 @@ FOUNDATION_EXPORT_CLASS
 + (instancetype)array;
 + (instancetype)arrayWithArray:(NSArray<ObjectType>*)anArray;
 + (instancetype)arrayWithContentsOfFile:(NSString*)aPath;
-+ (instancetype)arrayWithContentsOfURL:(NSURL*)aURL STUB_METHOD;
++ (instancetype)arrayWithContentsOfURL:(NSURL*)aURL;
 + (instancetype)arrayWithObject:(ObjectType)anObject;
 + (instancetype)arrayWithObjects:(ObjectType)firstObj, ...;
 + (instancetype)arrayWithObjects:(const ObjectType _Nonnull[])objects count:(NSUInteger)count;
 - (instancetype)initWithArray:(NSArray<ObjectType>*)anArray;
 - (instancetype)initWithArray:(NSArray<ObjectType>*)array copyItems:(BOOL)flag;
 - (instancetype)initWithContentsOfFile:(NSString*)aPath;
-- (instancetype)initWithContentsOfURL:(NSURL*)aURL STUB_METHOD;
+- (instancetype)initWithContentsOfURL:(NSURL*)aURL;
 - (instancetype)initWithObjects:(ObjectType)firstObj, ...;
 - (instancetype)initWithObjects:(const ObjectType _Nonnull[])objects count:(NSUInteger)count;
 - (BOOL)containsObject:(ObjectType)anObject;
@@ -110,17 +110,17 @@ FOUNDATION_EXPORT_CLASS
 - (NSString*)descriptionWithLocale:(id)locale STUB_METHOD;
 - (NSString*)descriptionWithLocale:(id)locale indent:(NSUInteger)level STUB_METHOD;
 - (BOOL)writeToFile:(NSString*)path atomically:(BOOL)flag;
-- (BOOL)writeToURL:(NSURL*)aURL atomically:(BOOL)flag STUB_METHOD;
+- (BOOL)writeToURL:(NSURL*)aURL atomically:(BOOL)flag;
 - (NSArray<NSString*>*)pathsMatchingExtensions:(NSArray<NSString*>*)filterTypes;
 - (void)removeObserver:(NSObject*)observer
-  fromObjectsAtIndexes:(NSIndexSet*)indexes
+    fromObjectsAtIndexes:(NSIndexSet*)indexes
+              forKeyPath:(NSString*)keyPath
+                 context:(void*)context STUB_METHOD;
+- (void)addObserver:(NSObject*)anObserver
+    toObjectsAtIndexes:(NSIndexSet*)indexes
             forKeyPath:(NSString*)keyPath
+               options:(NSKeyValueObservingOptions)options
                context:(void*)context STUB_METHOD;
-- (void)addObserver:(NSObject*)anObserver
- toObjectsAtIndexes:(NSIndexSet*)indexes
-         forKeyPath:(NSString*)keyPath
-            options:(NSKeyValueObservingOptions)options
-            context:(void*)context STUB_METHOD;
 - (void)removeObserver:(NSObject*)anObserver fromObjectsAtIndexes:(NSIndexSet*)indexes forKeyPath:(NSString*)keyPath STUB_METHOD;
 - (void)setValue:(id)value forKey:(NSString*)key;
 - (id)valueForKey:(NSString*)key;

tests/unittests/Foundation/NSArrayTests.mm

@@ -434,4 +434,29 @@ static unsigned long int objectIndexInArray(NSArray* array, int value, int start
     EXPECT_ANY_THROW([arr replaceObjectAtIndex:0 withObject:nil]);
     EXPECT_OBJCEQ(@"hello", arr[0]);
     EXPECT_EQ(1, [arr count]);
+}
+
+TEST(NSArray, ReadWriteURL) {
+    NSURL* url = [NSURL fileURLWithPath:@"arrayTestData.txt" isDirectory:NO];
+    NSArray* arr = @[ @1, @[ @2, @"3" ], @"4", @{ @"5" : @6 } ];
+    EXPECT_TRUE([arr writeToURL:url atomically:NO]);
+    NSArray* read = [NSArray arrayWithContentsOfURL:url];
+    EXPECT_OBJCEQ(arr, read);
+}
+
+TEST(NSArray, ShouldNotBeAbleToWriteInvalidToURL) {
+    NSURL* url = [NSURL fileURLWithPath:@"arrayTestData.txt" isDirectory:NO];
+
+    // Keys in dictionary must be NSString* to be written
+    NSArray* arr = @[ @1, @{ @2 : @"3" } ];
+    EXPECT_FALSE([arr writeToURL:url atomically:NO]);
+
+    // NSURL* is not a PropertyList object so cannot be written
+    NSArray* arr2 = @[ url, @1 ];
+    EXPECT_FALSE([arr2 writeToURL:url atomically:NO]);
+
+    // Array cannot have a circular dependency
+    NSMutableArray* mutableArr = [NSMutableArray arrayWithObject:@1];
+    [mutableArr addObject:mutableArr];
+    EXPECT_FALSE([mutableArr writeToURL:url atomically:NO]);
 }