Merge pull request #28 from plrthink/add-example

Add example

Author: plrthink

.npmignore

@@ -26,3 +26,5 @@ project.xcworkspace
 #
 node_modules/
 npm-debug.log
+
+example/

README.md

@@ -2,102 +2,64 @@
 
 Zip archive utility for react-native
 
+> ### Important
+> If you're using react-native after 0.40.0 on iOS, be sure to use > 0.1.0 of this package.
+
 ## Installation
 
 ```bash
 npm install react-native-zip-archive --save
+react-native link react-native-zip-archive
 ```
 
-## Getting started - iOS
-
-1. In Xcode, in the project navigator right click `Libraries` ➜ `Add Files to [your project's name]`
-2. Go to `node_modules` ➜ `react-native-zip-archive` and add `RNZipArchive.xcodeproj`
-3. Add `libRNZipArchive.a` (from 'Products' under RNZipArchive.xcodeproj) to your project's `Build Phases` ➜ `Link Binary With Libraries` phase
-4. Add the `libz` library to your target
-5. Look for Header Search Paths and make sure it contains both `$(SRCROOT)/../react-native/React` and `$(SRCROOT)/../../React` - mark both as recursive
-6. Run your project (`CMD+R`)
-
-Warning: If you're using [rnpm](https://github.com/rnpm/rnpm) to link this module, you also need manually link `libz` library to your target otherwise your project wouldn't compile.
-
-## Getting started - Android
-
-* Edit `android/settings.gradle` to look like this (without the +):
-
-  ```diff
-  rootProject.name = 'MyApp'
-
-  include ':app'
-
-  + include ':react-native-zip-archive'
-  + project(':react-native-zip-archive').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-zip-archive/android')
-  ```
-
-* Edit `android/app/build.gradle` (note: **app** folder) to look like this:
-
-  ```diff
-  apply plugin: 'com.android.application'
-
-  android {
-    ...
-  }
-
-  dependencies {
-    compile fileTree(dir: 'libs', include: ['*.jar'])
-    compile 'com.android.support:appcompat-v7:23.0.0'
-    compile 'com.facebook.react:react-native:0.16.+'
-  + compile project(':react-native-zip-archive')
-  }
-  ```
-
-* Edit your `MainActivity.java` (deep in `android/app/src/main/java/...`) to look like this (note **two** places to edit):
-
-  ```diff
-  package com.myapp;
-
-  + import com.rnziparchive.RNZipArchivePackage;
-
-  ....
-
-    @Override
-    protected List<ReactPackage> getPackages() {
-      return Arrays.<ReactPackage>asList(
-        new MainReactPackage(),
-  +     new RNZipArchivePackage()
-      );
-    }
-
-  }
-  ```
-
 ## Usage
 
-require it in your file
+import it into your code
 
 ```js
-const ZipArchive = require('react-native-zip-archive')
+import { zip, unzip, unzipAssets, subscribe } from 'react-native-zip-archive'
 ```
 
 you may also want to use something like [react-native-fs](https://github.com/johanneslumpe/react-native-fs) to access the file system (check its repo for more information)
 
 ```js
-const RNFS = require('react-native-fs')
+import { MainBundlePath, DocumentDirectoryPath } from 'react-native-fs'
 ```
 
 ## API
 
+**zip(source: string, target: string): Promise**
+
+> zip source to target
+
+Example
+
+```js
+const targetPath = `${DocumentDirectoryPath}/myFile.zip`
+const sourcePath = DocumentDirectoryPath
+
+zip(sourcePath, targetPath)
+.then((path) => {
+  console.log(`unzip completed at ${path}`)
+})
+.catch((error) => {
+  console.log(error)
+})
+```
+
 **unzip(source: string, target: string): Promise**
 
 > unzip from source to target
 
 Example
 
 ```js
-let sourcePath = 'path_to_your_zip_file'
-let targetPath = RNFS.DocumentDirectoryPath
+const sourcePath = `${DocumentDirectoryPath}/myFile.zip`
+const targetPath = DocumentDirectoryPath
 
-ZipArchive.unzip(sourcePath, targetPath)
-.then(() => {
-  console.log('unzip completed!')
+unzip(sourcePath, targetPath)
+.then((path) => {
+  console.log(`unzip completed at ${path}`)
 })
 .catch((error) => {
   console.log(error)
@@ -113,10 +75,10 @@ ZipArchive.unzip(sourcePath, targetPath)
 `assetPath` is the relative path to the file inside the pre-bundled assets folder, e.g. `folder/myFile.zip`. Do not pass an absolute directory.
 
 ```js
-const assetPath = 'folder/myFile.zip'
-const targetPath = RNFS.DocumentDirectoryPath
+const assetPath = `${DocumentDirectoryPath}/myFile.zip`
+const targetPath = DocumentDirectoryPath
 
-ZipArchive.unzipAssets(assetPath, targetPath)
+unzipAssets(assetPath, targetPath)
 .then(() => {
   console.log('unzip completed!')
 })
@@ -137,7 +99,7 @@ Your callback will be passed an object with the following fields:
 
 ```js
 componentWillMount() {
-  this.zipProgress = ZipArchive.subscribe((e) => {
+  this.zipProgress = subscribe((e) => {
     this.setState({ zipProgress: e.progress })
   })
 }

android/build.gradle

@@ -30,5 +30,5 @@ repositories {
 }
 
 dependencies {
-    compile 'com.facebook.react:react-native:0.12.+'
+    compile "com.facebook.react:react-native:+"
 }

android/src/main/java/com/rnziparchive/RNZipArchiveModule.java

@@ -4,7 +4,7 @@
 import android.util.Log;
 
 import com.facebook.react.bridge.Arguments;
-import com.facebook.react.bridge.Callback;
+import com.facebook.react.bridge.Promise;
 import com.facebook.react.bridge.ReactApplicationContext;
 import com.facebook.react.bridge.ReactContextBaseJavaModule;
 import com.facebook.react.bridge.ReactMethod;
@@ -43,21 +43,27 @@ public String getName() {
   }
 
   @ReactMethod
-  public void unzip(String zipFilePath, String destDirectory, Callback callback) {
+  public void unzip(String zipFilePath, String destDirectory, Promise promise) {
     FileInputStream inputStream;
     File file;
     try {
       inputStream = new FileInputStream(zipFilePath);
       file = new File(zipFilePath);
     } catch (FileNotFoundException | NullPointerException e) {
-      callback.invoke(makeErrorPayload("Couldn't open file " + zipFilePath + ". ", e));
+      promise.reject(null, "Couldn't open file " + zipFilePath + ". ");
       return;
     }
-    unzipStream(zipFilePath, destDirectory, inputStream, file.length(), callback);
+    try {
+      unzipStream(zipFilePath, destDirectory, inputStream, file.length());
+    } catch (Exception ex) {
+      promise.reject(null, ex.getMessage());
+      return;
+    }
+    promise.resolve(destDirectory);
   }
 
   @ReactMethod
-  public void unzipAssets(String assetsPath, String destDirectory, Callback completionCallback) {
+  public void unzipAssets(String assetsPath, String destDirectory, Promise promise) {
     InputStream assetsInputStream;
     long size;
 
@@ -66,15 +72,21 @@ public void unzipAssets(String assetsPath, String destDirectory, Callback comple
       AssetFileDescriptor fileDescriptor = getReactApplicationContext().getAssets().openFd(assetsPath);
       size = fileDescriptor.getLength();
     } catch (IOException e) {
-      completionCallback.invoke(makeErrorPayload(String.format("Asset file `%s` could not be opened", assetsPath), e));
+      promise.reject(null, String.format("Asset file `%s` could not be opened", assetsPath));
       return;
     }
 
-    unzipStream(assetsPath, destDirectory, assetsInputStream, size, completionCallback);
+    try {
+      unzipStream(assetsPath, destDirectory, assetsInputStream, size);
+    } catch (Exception ex) {
+      promise.reject(null, ex.getMessage());
+      return;
+    }
+    promise.resolve(destDirectory);
   }
 
   @ReactMethod
-  public void zip(String fileOrDirectory, String destDirectory, Callback callback) {
+  public void zip(String fileOrDirectory, String destDirectory, Promise promise) {
     List<String> filePaths = new ArrayList<>();
     File file;
     try {
@@ -92,14 +104,21 @@ public void zip(String fileOrDirectory, String destDirectory, Callback callback)
         throw new FileNotFoundException(fileOrDirectory);
       }
     } catch (FileNotFoundException | NullPointerException e) {
-      callback.invoke(makeErrorPayload("Couldn't open file/directory " + fileOrDirectory + ". ", e));
+      promise.reject(null, "Couldn't open file/directory " + fileOrDirectory + ".");
       return;
     }
 
-    zipStream(filePaths.toArray(new String[filePaths.size()]), destDirectory, filePaths.size(), callback);
+    try {
+      zipStream(filePaths.toArray(new String[filePaths.size()]), destDirectory, filePaths.size());
+    } catch (Exception ex) {
+      promise.reject(null, ex.getMessage());
+      return;
+    }
+
+    promise.resolve(destDirectory);
   }
 
-  private void zipStream(String[] files, String destFile, long totalSize, Callback completionCallback) {
+  private void zipStream(String[] files, String destFile, long totalSize) throws Exception {
     try {
       if (destFile.contains("/")) {
         File destDir = new File(destFile.substring(0, destFile.lastIndexOf("/")));
@@ -136,11 +155,10 @@ private void zipStream(String[] files, String destFile, long totalSize, Callback
       }
       updateProgress(1, 1, destFile); // force 100%
       out.close();
-      completionCallback.invoke(null, null);
     } catch (Exception ex) {
       ex.printStackTrace();
       updateProgress(0, 1, destFile); // force 0%
-      completionCallback.invoke(makeErrorPayload(String.format("Couldn't zip %s", destFile), ex));
+      throw new Exception(String.format("Couldn't zip %s", destFile));
     }
   }
 
@@ -161,7 +179,7 @@ private List<File> getSubFiles(File baseDir, boolean isContainFolder) {
     return fileList;
   }
 
-  private void unzipStream(String zipFilePath, String destDirectory, InputStream inputStream, long totalSize, Callback completionCallback) {
+  private void unzipStream(String zipFilePath, String destDirectory, InputStream inputStream, long totalSize) throws Exception {
     try {
       File destDir = new File(destDirectory);
       if (!destDir.exists()) {
@@ -176,17 +194,17 @@ private void unzipStream(String zipFilePath, String destDirectory, InputStream i
 
       updateProgress(0, 1, zipFilePath); // force 0%
       File fout=null;
-      while((entry = zipIn.getNextEntry())!=null){  
-        if(entry.isDirectory()) continue;  
+      while((entry = zipIn.getNextEntry())!=null){
+        if(entry.isDirectory()) continue;
         fout=new File(destDirectory, entry.getName());
         if(!fout.exists()){
-          (new File(fout.getParent())).mkdirs();  
-        }  
+          (new File(fout.getParent())).mkdirs();
+        }
         FileOutputStream out=new FileOutputStream(fout);
         BufferedOutputStream Bout=new BufferedOutputStream(out);
-        int b;  
+        int b;
         while((b=bin.read())!=-1){
-          Bout.write(b); 
+          Bout.write(b);
         }
         Bout.close();
         out.close();
@@ -195,14 +213,13 @@ private void unzipStream(String zipFilePath, String destDirectory, InputStream i
       updateProgress(1, 1, zipFilePath); // force 100%
       bin.close();
       zipIn.close();
-      completionCallback.invoke(null, null);
     } catch (Exception ex) {
       ex.printStackTrace();
       updateProgress(0, 1, zipFilePath); // force 0%
-      completionCallback.invoke(makeErrorPayload(String.format("Couldn't extract %s", zipFilePath), ex));
+      throw new Exception(String.format("Couldn't extract %s", zipFilePath));
     }
   }
-  
+
   private void updateProgress(long extractedBytes, long totalSize, String zipFilePath) {
     double progress = (double) extractedBytes / (double) totalSize;
     Log.d(TAG, String.format("updateProgress: %.0f%%", progress * 100));
@@ -235,10 +252,4 @@ private long extractFile(ZipInputStream zipIn, String filePath) throws IOExcepti
 
     return size;
   }
-
-  private WritableMap makeErrorPayload(String message, Exception ex) {
-    WritableMap error = Arguments.createMap();
-    error.putString("message", String.format("%s (%s)", message, ex.getMessage()));
-    return error;
-  }
 }

example/.babelrc

@@ -0,0 +1,3 @@
+{
+"presets": ["react-native"]
+}

example/.buckconfig

@@ -0,0 +1,6 @@
+
+[android]
+  target = Google Inc.:Google APIs:23
+
+[maven_repositories]
+  central = https://repo1.maven.org/maven2

example/.flowconfig

@@ -0,0 +1,44 @@
+[ignore]
+; We fork some components by platform
+.*/*[.]android.js
+
+; Ignore "BUCK" generated dirs
+<PROJECT_ROOT>/\.buckd/
+
+; Ignore unexpected extra "@providesModule"
+.*/node_modules/.*/node_modules/fbjs/.*
+
+; Ignore duplicate module providers
+; For RN Apps installed via npm, "Libraries" folder is inside
+; "node_modules/react-native" but in the source repo it is in the root
+.*/Libraries/react-native/React.js
+.*/Libraries/react-native/ReactNative.js
+
+[include]
+
+[libs]
+node_modules/react-native/Libraries/react-native/react-native-interface.js
+node_modules/react-native/flow
+flow/
+
+[options]
+module.system=haste
+
+experimental.strict_type_args=true
+
+munge_underscores=true
+
+module.name_mapper='^[./a-zA-Z0-9$_-]+\.\(bmp\|gif\|jpg\|jpeg\|png\|psd\|svg\|webp\|m4v\|mov\|mp4\|mpeg\|mpg\|webm\|aac\|aiff\|caf\|m4a\|mp3\|wav\|html\|pdf\)$' -> 'RelativeImageStub'
+
+suppress_type=$FlowIssue
+suppress_type=$FlowFixMe
+suppress_type=$FixMe
+
+suppress_comment=\\(.\\|\n\\)*\\$FlowFixMe\\($\\|[^(]\\|(\\(>=0\\.\\(3[0-6]\\|[1-2][0-9]\\|[0-9]\\).[0-9]\\)? *\\(site=[a-z,_]*react_native[a-z,_]*\\)?)\\)
+suppress_comment=\\(.\\|\n\\)*\\$FlowIssue\\((\\(>=0\\.\\(3[0-6]\\|1[0-9]\\|[1-2][0-9]\\).[0-9]\\)? *\\(site=[a-z,_]*react_native[a-z,_]*\\)?)\\)?:? #[0-9]+
+suppress_comment=\\(.\\|\n\\)*\\$FlowFixedInNextDeploy
+
+unsafe.enable_getters_and_setters=true
+
+[version]
+^0.36.0

example/.gitattributes

@@ -0,0 +1 @@
+*.pbxproj -text