Create a macOS implementation of AsyncStorage + macOS example app and e2e tests

.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: CI
+
+on: 
+  push:
+    branches:
+      - LEGACY
+  pull_request:
+    branches:
+      - LEGACY
+
+jobs:
+  build:
+
+    runs-on: macOS-latest
+
+    steps:
+    - uses: actions/checkout@master
+    - name: Installing Yarn dependencies
+      run: yarn install
+    - name: Build macOS app
+      run: yarn build:e2e:macos
+    - name: Run e2e tests
+      run: yarn test:e2e:macos
+

.npmignore

@@ -24,6 +24,9 @@ jsconfig.json
 .eslintignore
 codecov.yml
 
+# Scripts
+scripts/
+
 # Example
 example/
 

CONTRIBUTING.md

@@ -10,7 +10,7 @@ We use `flow` for type check, `eslint` with `prettier` for linting/formatting, `
 * `yarn test`: Run all tests, except for e2e (see note below).
 * `yarn test:lint`: Run `eslint` check.
 * `yarn test:flow`: Run `flow` type check.
-* `yarn test:e2e:<ios|android>`: Runs e2e tests. Before you can run it, you should build the app that can be run, by using `yarn build:e2e:<ios|android>`.
+* `yarn test:e2e:<ios|android|macos>`: Runs e2e tests. Before you can run it, you should build the app that can be run, by using `yarn build:e2e:<ios|android|macos>`.
 
 
 ## Sending a pull request

README.md

@@ -40,6 +40,8 @@ $ cd ios/ && pod install
 
 See docs for [manual linking guide](docs/Linking.md)
 
+*Note* For `macOS` the [manual linking](docs/Linking.md) is currently the only linking option.
+
 ### **Upgrading to React Native *0.60+*** 
 
 New React Native comes with `autolinking` feature, which automatically links Native Modules in your project.

docs/Linking.md

@@ -22,6 +22,17 @@
 
 3. Run `pod install`
 
+## macOS
+
+#### Project linking
+1. Open your project `.xcodeproj` on xcode.
+
+2. Right click on the Libraries folder and select `Add files to "yourProjectName"`.
+
+3. Add `RNCAsyncStorage.xcodeproj` (located at `node_modules/@react-native-community/async-storage/macos`) to your project Libraries.
+
+3. Go to `Build Phases -> Link Binary with Libraries` and add:  `libRNCAsyncStorage-macOS.a`.
+
 
 ## Android
 1. Add project to `android/settings.gradle`:

docs/advanced/BrownfieldIntegration.md

@@ -3,7 +3,7 @@
 If you're embedding React Native into native application, you can also integrate
 Async Storage module, so that both worlds will use one storage solution.
 
-## iOS
+## iOS and macOS
 
 AsyncStorage can be controlled by the hosting app via the delegate on
 `RNCAsyncStorage`:

docs/advanced/IncreaseDbSize.md

@@ -15,6 +15,6 @@ AsyncStorage_db_size_in_MB=10
 Now you can define the new size in MB. In this example, the new limit is 10 MB.
 
 
-## iOS
+## iOS and macOS
 
 Async Storage size is not limited programmatically on iOS.

example/macos/AsyncStorageExample-macOS/AppDelegate+RNCAsyncStorageDelegate.h

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#import "AppDelegate.h"
+
+#import <RNCAsyncStorage/RNCAsyncStorageDelegate.h>
+
+@interface AppDelegate (RNCAsyncStorageDelegate) <RNCAsyncStorageDelegate>
+@end

example/macos/AsyncStorageExample-macOS/AppDelegate+RNCAsyncStorageDelegate.m

@@ -0,0 +1,65 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#import "AppDelegate+RNCAsyncStorageDelegate.h"
+
+#import <RNCAsyncStorage/RNCAsyncStorage.h>
+
+@implementation AppDelegate (RNCAsyncStorageDelegate)
+
+- (void)allKeys:(nonnull RNCAsyncStorageResultCallback)completion
+{
+  completion(self.memoryStorage.allKeys);
+}
+
+- (void)mergeValues:(nonnull NSArray<NSString *> *)values
+            forKeys:(nonnull NSArray<NSString *> *)keys
+         completion:(nonnull RNCAsyncStorageResultCallback)block
+{
+  [NSException raise:@"Unimplemented"
+              format:@"%@ is unimplemented", NSStringFromSelector(_cmd)];
+}
+
+- (void)removeAllValues:(nonnull RNCAsyncStorageCompletion)completion
+{
+  [self.memoryStorage removeAllObjects];
+  completion(nil);
+}
+
+- (void)removeValuesForKeys:(nonnull NSArray<NSString *> *)keys
+                 completion:(nonnull RNCAsyncStorageResultCallback)completion
+{
+  for (NSString *key in keys) {
+    [self.memoryStorage removeObjectForKey:key];
+  }
+  completion(@[]);
+}
+
+- (void)setValues:(nonnull NSArray<NSString *> *)values
+          forKeys:(nonnull NSArray<NSString *> *)keys
+       completion:(nonnull RNCAsyncStorageResultCallback)completion
+{
+  for (NSUInteger i = 0; i < values.count; ++i) {
+    NSString *value = values[i];
+    NSString *key = keys[i];
+    [self.memoryStorage setObject:value forKey:key];
+  }
+  completion(@[]);
+}
+
+- (void)valuesForKeys:(nonnull NSArray<NSString *> *)keys
+           completion:(nonnull RNCAsyncStorageResultCallback)completion
+{
+  NSMutableArray *values = [NSMutableArray arrayWithCapacity:keys.count];
+  for (NSString *key in keys) {
+    NSString *value = self.memoryStorage[key];
+    [values addObject:value == nil ? [NSNull null] : value];
+  }
+  completion(values);
+}
+
+@end

example/macos/AsyncStorageExample-macOS/AppDelegate.h

@@ -0,0 +1,17 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#import <Cocoa/Cocoa.h>
+
+@class RCTBridge;
+
+@interface AppDelegate : NSObject <NSApplicationDelegate>
+
+@property (nonatomic, readonly) RCTBridge *bridge;
+@property (nonatomic, strong) NSMutableDictionary<NSString *, NSString *> *memoryStorage;
+
+@end

example/macos/AsyncStorageExample-macOS/AppDelegate.m

@@ -0,0 +1,60 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#import "AppDelegate.h"
+
+#import "AppDelegate+RNCAsyncStorageDelegate.h"
+#import "RNCTestAsyncStorageDelegate.h"
+#import <RNCAsyncStorage/RNCAsyncStorage.h>
+
+#import <React/RCTBridge.h>
+#import <React/RCTBundleURLProvider.h>
+
+@interface AppDelegate () <RCTBridgeDelegate>
+
+@end
+
+@implementation AppDelegate {
+  RNCTestAsyncStorageDelegate *_testDelegate;
+}
+
+- (void)awakeFromNib {
+  [super awakeFromNib];
+
+  _bridge = [[RCTBridge alloc] initWithDelegate:self launchOptions:nil];
+
+  _memoryStorage = [NSMutableDictionary dictionary];
+}
+
+- (void)application:(NSApplication *)application openURLs:(NSArray<NSURL *> *)urls {
+  NSURL *url = [urls firstObject];
+
+  if (![url.scheme isEqualToString:@"rnc-asyncstorage"]) {
+    return;
+  }
+
+  if ([url.host isEqualToString:@"set-delegate"]) {
+    if (_testDelegate == nil) {
+      _testDelegate = [RNCTestAsyncStorageDelegate new];
+    }
+    RNCAsyncStorage *asyncStorage = [_bridge moduleForClass:[RNCAsyncStorage class]];
+    asyncStorage.delegate = _testDelegate;
+  } else if ([url.host isEqualToString:@"unset-delegate"]) {
+    RNCAsyncStorage *asyncStorage = [_bridge moduleForClass:[RNCAsyncStorage class]];
+    asyncStorage.delegate = nil;
+  } else if ([url.host isEqualToString:@"clear-all-data"]) {
+    [RNCAsyncStorage clearAllData];
+  }
+}
+
+#pragma mark - RCTBridgeDelegate Methods
+
+- (NSURL *)sourceURLForBridge:(__unused RCTBridge *)bridge {
+  return [[RCTBundleURLProvider sharedSettings] jsBundleURLForBundleRoot:@"example/index" fallbackResource:@"main"]; // .jsbundle;
+}
+
+@end

example/macos/AsyncStorageExample-macOS/Info.plist

@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>$(DEVELOPMENT_LANGUAGE)</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIconFile</key>
+	<string></string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>$(PRODUCT_NAME)</string>
+	<key>CFBundlePackageType</key>
+	<string>APPL</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleURLTypes</key>
+	<array>
+		<dict>
+			<key>CFBundleTypeRole</key>
+			<string>Editor</string>
+			<key>CFBundleURLName</key>
+			<string>org.reactjs.native.example.AsyncStorageExample</string>
+			<key>CFBundleURLSchemes</key>
+			<array>
+				<string>rnc-asyncstorage</string>
+			</array>
+		</dict>
+	</array>
+	<key>CFBundleVersion</key>
+	<string>1</string>
+	<key>LSMinimumSystemVersion</key>
+	<string>$(MACOSX_DEPLOYMENT_TARGET)</string>
+	<key>NSAppTransportSecurity</key>
+	<dict>
+		<key>NSAllowsArbitraryLoads</key>
+		<true/>
+	</dict>
+	<key>NSHumanReadableCopyright</key>
+	<string>Copyright © 2017 Facebook. All rights reserved.</string>
+	<key>NSMainStoryboardFile</key>
+	<string>Main</string>
+	<key>NSPrincipalClass</key>
+	<string>NSApplication</string>
+</dict>
+</plist>