8.0.11

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pushrocks/smartfile",
   "private": false,
-  "version": "8.0.6",
+  "version": "8.0.11",
   "description": "offers smart ways to work with files in nodejs",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
@@ -25,25 +25,25 @@
   "homepage": "https://gitlab.com/pushrocks/smartfile",
   "dependencies": {
     "@pushrocks/smartfile-interfaces": "^1.0.7",
-    "@pushrocks/smarthash": "^2.1.6",
+    "@pushrocks/smarthash": "^2.1.10",
-    "@pushrocks/smartjson": "^4.0.3",
+    "@pushrocks/smartjson": "^4.0.6",
-    "@pushrocks/smartmime": "^1.0.3",
+    "@pushrocks/smartmime": "^1.0.5",
     "@pushrocks/smartpath": "^4.0.3",
-    "@pushrocks/smartpromise": "^3.0.6",
+    "@pushrocks/smartpromise": "^3.1.6",
-    "@pushrocks/smartrequest": "^1.1.51",
+    "@pushrocks/smartrequest": "^1.1.52",
-    "@types/fs-extra": "^9.0.1",
+    "@types/fs-extra": "^9.0.13",
-    "@types/glob": "^7.1.3",
+    "@types/glob": "^7.2.0",
-    "@types/js-yaml": "^3.12.5",
+    "@types/js-yaml": "^4.0.5",
-    "fs-extra": "^9.0.1",
+    "fs-extra": "^10.0.0",
-    "glob": "^7.1.6",
+    "glob": "^7.2.0",
-    "js-yaml": "^3.14.0"
+    "js-yaml": "^4.1.0"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.25",
+    "@gitzone/tsbuild": "^2.1.28",
-    "@gitzone/tsrun": "^1.2.12",
+    "@gitzone/tsrun": "^1.2.18",
-    "@gitzone/tstest": "^1.0.52",
+    "@gitzone/tstest": "^1.0.60",
-    "@pushrocks/tapbundle": "^3.2.9",
+    "@pushrocks/tapbundle": "^3.2.14",
-    "@types/node": "^14.11.2",
+    "@types/node": "^16.11.11",
     "gulp-function": "^2.2.14",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"

test/test.ts

@@ -1,5 +1,5 @@
 import * as smartfile from '../ts/index';
-import path = require('path');
+import * as path from 'path';
 
 import { expect, tap } from '@pushrocks/tapbundle';
 
@@ -8,7 +8,9 @@ import { expect, tap } from '@pushrocks/tapbundle';
 // ---------------------------
 
 tap.test('.fs.fileExistsSync -> should return an accurate boolean', async () => {
+  // tslint:disable-next-line: no-unused-expression
   expect(smartfile.fs.fileExistsSync('./test/testassets/mytest.json')).to.be.true;
+  // tslint:disable-next-line: no-unused-expression
   expect(smartfile.fs.fileExistsSync('./test/testassets/notthere.json')).be.false;
 });
 

test/test.virtualdirectory.ts

@@ -0,0 +1,15 @@
+import { tap, expect } from '@pushrocks/tapbundle';
+
+import * as smartfile from '../ts';
+
+tap.test('should create a virtualdirectory', async () => {
+  const virtualDir = await smartfile.VirtualDirectory.fromFsDirPath('./test/testassets/testfolder');
+  expect(virtualDir.smartfileArray.length).to.equal(4);
+});
+
+tap.test('should write to a directory', async () => {
+  const virtualDir = await smartfile.VirtualDirectory.fromFsDirPath('./test/testassets/testfolder');
+  virtualDir.saveToDisk('./test/testassets/test');
+});
+
+tap.start();

test/testassets/test/subfolder/deepsubfolder/deepsubtestfile.txt

@@ -0,0 +1 @@
+okidoks

test/testassets/test/subfolder/subtestfile.txt

@@ -0,0 +1 @@
+hi

ts/index.ts

@@ -4,7 +4,7 @@ import * as SmartfileInterpreter from './smartfile.interpreter';
 import * as SmartfileMemory from './smartfile.memory';
 import * as SmartfileRemote from './smartfile.remote';
 
-export { Smartfile } from './smartfile.classes.smartfile';
+export { Smartfile, ISmartfileConstructorOptions } from './smartfile.classes.smartfile';
 export { VirtualDirectory } from './smartfile.classes.virtualdirectory';
 
 export let fs = SmartfileFs;

ts/smartfile.classes.smartfile.ts

@@ -53,6 +53,10 @@ export class Smartfile extends plugins.smartjson.Smartjson {
     return smartfile;
   }
 
+  public static async fromFoldedJson(foldedJsonArg: string) {
+    return new Smartfile(plugins.smartjson.parse(foldedJsonArg));
+  }
+
   // ========
   // INSTANCE
   // ========
@@ -113,19 +117,50 @@ export class Smartfile extends plugins.smartjson.Smartjson {
   }
 
   /**
-   * write file to disk
+   * write file to disk at its original location
    * Behaviours:
    * - no argument write to exactly where the file was picked up
    */
-  public async write(pathArg?: string) {
+  public async write() {
-    const stringToWrite = this.contentBuffer.toString();
+    await memory.toFs(this.contentBuffer, this.path);
-    await memory.toFs(stringToWrite, this.path);
+  }
+
+  /**
+   * writes the file to path given as argument
+   * @param filePathArg
+   */
+  public async writeToDiskAtPath(filePathArg: string) {
+    if (!plugins.path.isAbsolute(filePathArg)) {
+      filePathArg = plugins.path.join(process.cwd(), filePathArg);
+    }
+    await memory.toFs(this.contentBuffer, filePathArg);
+  }
+
+  /**
+   * writes the file to a directory combined with the relative path portion
+   * @param dirPathArg
+   * @returns
+   */
+  public async writeToDir(dirPathArg: string) {
+    dirPathArg = plugins.smartpath.transform.toAbsolute(dirPathArg);
+    const filePath = plugins.path.join(dirPathArg, this.path);
+    await memory.toFs(this.contentBuffer, filePath);
+    return filePath;
   }
 
   /**
    * read file from disk
    */
-  public async read() {}
+  public async read() {
+    this.contentBuffer = await fs.toBuffer(this.path);
+  }
+
+  /**
+   * deletes the file from disk at its original location
+   */
+  public async delete() {
+    await fs.remove(this.path);
+  }
 
   // -----------------------------------------------
   // vinyl compatibility

ts/smartfile.classes.virtualdirectory.ts

@@ -24,16 +24,16 @@ export class VirtualDirectory {
   }
 
   // INSTANCE
-  private fileArray: Smartfile[] = [];
+  public smartfileArray: Smartfile[] = [];
 
   constructor() {}
 
   public addSmartfiles(smartfileArrayArg: Smartfile[]) {
-    this.fileArray = this.fileArray.concat(smartfileArrayArg);
+    this.smartfileArray = this.smartfileArray.concat(smartfileArrayArg);
   }
 
   public async getFileByPath(pathArg: string) {
-    for (const smartfile of this.fileArray) {
+    for (const smartfile of this.smartfileArray) {
       if (smartfile.path === pathArg) {
         return smartfile;
       }
@@ -42,10 +42,20 @@ export class VirtualDirectory {
 
   public async toVirtualDirTransferableObject(): Promise<plugins.smartfileInterfaces.VirtualDirTransferableObject> {
     return {
-      files: this.fileArray.map(smartfileArg => smartfileArg.foldToJson())
+      files: this.smartfileArray.map(smartfileArg => smartfileArg.foldToJson())
     };
   }
 
+  public async saveToDisk(dirArg: string) {
+    console.log(`writing VirtualDirectory with ${this.smartfileArray.length} to directory:
+    --> ${dirArg}`);
+    for (const smartfileArg of this.smartfileArray) {
+      const filePath = await smartfileArg.writeToDir(dirArg);
+      console.log(`wrote ${smartfileArg.relative} to
+        --> ${filePath}`);
+    }
+  }
+
   // TODO implement root shifting to get subdirectories as new virtual directories
   // TODO implement root shifting to combine VirtualDirecotries in a parent virtual directory
 }

ts/smartfile.fs.ts

@@ -202,6 +202,10 @@ export const toStringSync = (filePath: string): string => {
   return fileString;
 };
 
+export const toBuffer = async (filePath: string): Promise<Buffer> => {
+  return plugins.fsExtra.readFile(filePath);
+};
+
 export const toBufferSync = (filePath: string): Buffer => {
   return plugins.fsExtra.readFileSync(filePath);
 };
@@ -227,7 +231,7 @@ export const fileTreeToObject = async (dirPathArg: string, miniMatchFilter: stri
   if (plugins.path.isAbsolute(miniMatchFilter)) {
     dirPath = '/';
   } else {
-    dirPath = dirPathArg;
+    dirPath = plugins.smartpath.transform.toAbsolute(dirPathArg);
   }
 
   const fileTree = await listFileTree(dirPath, miniMatchFilter);

ts/smartfile.interpreter.ts

@@ -10,7 +10,7 @@ export let objectFile = (fileStringArg: string, fileTypeArg) => {
   switch (fileTypeArg) {
     case 'yml':
     case 'yaml':
-      return plugins.yaml.safeLoad(fileStringArg);
+      return plugins.yaml.load(fileStringArg);
     case 'json':
       return JSON.parse(fileStringArg);
     default:

ts/smartfile.memory.ts

@@ -1,8 +1,7 @@
-import plugins = require('./smartfile.plugins');
+import * as plugins from './smartfile.plugins';
 import { Smartfile } from './smartfile.classes.smartfile';
 import * as smartfileFs from './smartfile.fs';
-
+import * as interpreter from './smartfile.interpreter';
-import SmartfileInterpreter = require('./smartfile.interpreter');
 
 /**
  * converts file to Object
@@ -10,8 +9,8 @@ import SmartfileInterpreter = require('./smartfile.interpreter');
  * @param fileTypeArg
  * @returns {any|any}
  */
-export let toObject = function (fileStringArg: string, fileTypeArg: string) {
+export let toObject = (fileStringArg: string, fileTypeArg: string) => {
-  return SmartfileInterpreter.objectFile(fileStringArg, fileTypeArg);
+  return interpreter.objectFile(fileStringArg, fileTypeArg);
 };
 
 export interface IToFsOptions {