gina 0.1.1-alpha.19 → 0.1.1-alpha.191

package/framework/{v0.1.1-alpha.19 → v0.1.1-alpha.191}/helpers/path.js

@@ -1,17 +1,19 @@
 /*
  * This file is part of the gina package.
- * Copyright (c) 2009-2022 Rhinostone <contact@gina.io>
+ * Copyright (c) 2009-2023 Rhinostone <contact@gina.io>
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 
-var fs = require('fs');
-var Events = require('events');
-var Path = require('path');
+var fs          = require('fs');
+var util        = require('util');
+var Events      = require('events');
+var Path        = require('path');
+var execSync    = require('child_process').execSync;
 
-var merge = require('./../lib/merge');
-var console = require('./../lib/logger');
+var merge       = require('./../lib/merge');
+var console     = require('./../lib/logger');
 
 var ContextHelper = require('./context');
 var e =  new Events.EventEmitter();
@@ -22,7 +24,7 @@ e.setMaxListeners(100);
 /**
  * PathHelper
  *
- * @package     Gina.Utils.Helpers
+ * @package     Gina.Lib.Helpers
  * @author      Rhinzostone <contact@gina.io>
  * @api public
  *
@@ -33,7 +35,7 @@ function PathHelper() {
 
     this.paths = [];
     var _this = this;
-    
+
     /**
      * _
      * PathHelper Constructor
@@ -47,11 +49,23 @@ function PathHelper() {
      * */
 
     _ = function(path, force) {
-        
+
         if ( typeof(path) == 'undefined' || !path || path == '' || path.length <=2 ) {
             throw new Error('This source cannot be used: `'+ path +'`')
         }
-        
+
+        // $HOME detection
+        if ( /^\~/.test(path) ) {
+            var homedir = null;
+            try {
+                homedir = execSync('echo $HOME').toString().replace(/(\r|\n)$/g, '');
+            } catch (err) {
+                throw err
+            }
+
+            path = path.replace(/^\~/, homedir);
+        }
+
         if ( typeof(force) == undefined) {
             force = _this.force = false
         }
@@ -115,14 +129,14 @@ function PathHelper() {
                     if (_this.paths.indexOf(path) < 0) {
                         _this.paths.push(path)
                     }
-                }                
-                
+                }
+
                 return path
             }
         }
         return null
     };
-    
+
 
     _.prototype.sep = Path.sep;
     _.prototype.start = (process.platform != "win32") ? "/" : "";
@@ -138,10 +152,12 @@ function PathHelper() {
      * myPathObj.toString()
      * */
     _.prototype.toString = function() {
-        var self = this;
-        var path = self.value;
-        var i = _this.paths.indexOf(path);
-        return ( i > -1 ) ? _this.paths[i] : path
+        // var self = this;
+        // var path = self.value;
+        // var i = _this.paths.indexOf(path);
+        // return ( i > -1 ) ? _this.paths[i] : path
+
+        return (process.platform != "win32") ? toUnixStyle(this) : toWin32Style(this)
     }
 
     /**
@@ -224,47 +240,96 @@ function PathHelper() {
         }
         return self
     }
-    
-    var existsSync = function(value) {        
+
+    var isDirectory = function(value) {
+        try {
+            if ( fs.lstatSync(value).isDirectory() && !fs.lstatSync(value).isSymbolicLink() ) {
+                return true
+            }
+        } catch (dirErr) {}
+
+        return false;
+    }
+    _.prototype.isDirectory = function() {
+        return isDirectory(this.value)
+    }
+
+    var isSymlinkSync = function(value) {
+        try {
+            if ( fs.lstatSync(value).isSymbolicLink() ) {
+                return true
+            }
+        } catch (linkErr) {}
+
+        return false;
+    }
+    _.prototype.isSymlinkSync = function() {
+        return isSymlinkSync(this.value)
+    }
+
+    _.prototype.getSymlinkSourceSync = function() {
+        if ( !isSymlinkSync(this.value) ) {
+            throw new Error('Path `'+ this.value +'` is not a symbolic link !')
+        }
+        return fs.readlinkSync(this.value)
+    }
+
+    var existsSync = function(value) {
         if ( typeof(fs.accessSync) != 'undefined' ) {
             try {
                 fs.accessSync(value, fs.constants.F_OK);
                 return true;
             } catch (err) {
+                // to handle symlinks
+                try {
+                    if ( fs.lstatSync(value).isSymbolicLink() ) {
+                        return true
+                    }
+                } catch (linkErr) {}
+
                 return false;
             }
+
         } else { // support for old version of nodejs
             return fs.existsSync(value);
-        } 
+        }
     }
     _.prototype.existsSync = function() {
         return existsSync(this.value);
     }
-    
+
+
     var exists = function(value, callback) {
         if ( typeof(fs.access) != 'undefined' ) {
             fs.access(value, fs.constants.F_OK, (err) => {
+                // to handle symlinks
+                try {
+                    if ( fs.lstatSync(value).isSymbolicLink() ) {
+                        return callback(true)
+                    }
+                } catch (linkErr) {}
+
                 callback( (err) ? false: true )
             });
         } else { // support for old version of nodejs
             fs.exists(value, function(found) {
                 callback(found)
             })
-        }  
+        }
     }
-    _.prototype.exists = function(callback) {        
+    _.prototype.exists = function(callback) {
         exists(this.value, callback);
     }
-    
+
     _.prototype.isWritableSync = function() {
-        
+
         if ( typeof(fs.accessSync) != 'undefined' ) {
             try {
                 fs.accessSync(this.value, fs.constants.W_OK);
-                return true    
+                return true
             } catch (err) {
                 return false
-            }        
+            }
         } else { // support for old version of nodejs
             var canWrite = false
             try {
@@ -273,10 +338,10 @@ function PathHelper() {
                 canWrite = false
             }
             return canWrite
-        } 
+        }
     }
 
-    _.prototype.isWritable = function(callback) {        
+    _.prototype.isWritable = function(callback) {
         if ( typeof(fs.access) != 'undefined' ) {
             fs.access(this.value, fs.constants.F_OK, (err) => {
                 callback( (err) ? false: true )
@@ -289,7 +354,7 @@ function PathHelper() {
                 }
                 callback( canWrite )
             })
-        }   
+        }
     }
 
     /**
@@ -496,16 +561,16 @@ function PathHelper() {
             }
         }
     }
-    
+
     /**
      * symlinkSync
-     * 
-     * @param {string} source 
-     * @param {string} destination 
+     *
+     * @param {string} source
+     * @param {string} destination
      * @param {string} type - Only available from node v12.0.0 & only available on Windows and ignored on other platforms
      */
      var symlinkSync = function(source, destination, type) {
-        // About junstion for windows (only): 
+        // About junstion for windows (only):
         // reminders: creating a symbolic link requires special privilege (by default, only available to elevated processes) whereas creating a junction only requires access to the file system.
         // https://docs.microsoft.com/en-us/sysinternals/downloads/junction
         // https://superuser.com/questions/343074/directory-junction-vs-directory-symbolic-link
@@ -513,19 +578,19 @@ function PathHelper() {
             throw new Error('Cannot complete symlinkSync from `'+ source +'`: the path does not exist.');
         }
         var nodeVersion = process.version.replace(/v/, '').split(/\./g)[0];
-        
+
         if (
-            process.platform == "win32" 
-            && ~~nodeVersion >= 12 
+            process.platform == "win32"
+            && ~~nodeVersion >= 12
             && typeof(type) == 'undefined'
             ||
-            process.platform == "win32" 
-            && ~~nodeVersion >= 12 
+            process.platform == "win32"
+            && ~~nodeVersion >= 12
             && !type
             ||
-            process.platform == "win32" 
-            && ~~nodeVersion >= 12 
-            && type == '' 
+            process.platform == "win32"
+            && ~~nodeVersion >= 12
+            && type == ''
         ) {
             // check source type
             if ( fs.lstatSync( source ).isDirectory() ) {
@@ -535,49 +600,49 @@ function PathHelper() {
                 type = 'file'
             }
         }
-        
-        if ( 
-            process.platform == "win32" 
-            && ~~nodeVersion >= 12 
-            && typeof(type) != 'undefined' 
-            && type != 'null' 
+
+        if (
+            process.platform == "win32"
+            && ~~nodeVersion >= 12
+            && typeof(type) != 'undefined'
+            && type != 'null'
             && type != ''
         ) { // can use type
-            
+
             if ( ['dir', 'file', 'junction'].indexOf(type) < 0 ) {
                 throw new Error('Wrong symlink type: '+ type);
             }
         }
-        
+
         fs.symlinkSync(source, destination, type);
     }
     _.prototype.symlinkSync = function(destination, type) {
         var self = this;
         var source = self.value;
-        
+
         // if ( !existsSync(source) ) {
         //     throw new Error('Cannot complete symlink from `'+ source +'`: the path does not exist.');
         // }
         symlinkSync(source, destination, type);
-        
+
     }
-    
+
     _.prototype.renameSync = function(destination) {
         var self = this;
         var source = self.value;
-        
+
         if ( !existsSync(source) ) {
             throw new Error('Cannot complete rename from `'+ source +'`: the path does not exist.');
         }
-        
+
         try {
             fs.renameSync(source, destination);
         } catch (err) {
             throw err
-        }        
+        }
     }
-    
-    
+
+
     /**
      * copy, file or entire folder
      *
@@ -600,21 +665,22 @@ function PathHelper() {
      * */
 
     _.prototype.cp = function(target, excluded, cb) {
-        
-        if ( typeof(target) == 'undefined' || !target || target == '' || target.length <=2 ) {
-            cb( new Error('This target cannot be used: `'+ target +'`'));
-            return;
-        }
-        
+
         if ( typeof(excluded) == 'function') {
             cb = excluded;
             excluded = undefined
         }
+
+        if ( typeof(target) == 'undefined' || !target || target == '' || target.length <=2 ) {
+            cb( new Error('This target cannot be used: `'+ target +'`'));
+            return;
+        }
+
         var self = this;
         //Enter dir & start rm.
         var p = self.value;
         //console.debug("starting copying ", p, " => ", target);
-                        
+
         cp(p, target, excluded)
             .onComplete( function(err, destination, method) {
                 cb(err, destination);
@@ -623,11 +689,11 @@ function PathHelper() {
     }
 
     var cp = function(source, destination, excluded) {
-        
+
         if ( !existsSync(source) ) {
             throw new Error('Cannot complete copy from `'+ source +'`: the path does not exist.');
         }
-        
+
         /**
          * BO Targeting folder content
          * This only matters when copy is done Folder To Folder.
@@ -665,12 +731,12 @@ function PathHelper() {
             // 1) File => Dir (add if exist else, throw error).
             // 2) File => File (create or replace if exists).
             // 3) Dir => Dir (create or replace if exists).
-            
+
             if (err) {
                 e.emit("cp#complete", err);
                 return;
             }
-            
+
             if ( stats.isSymbolicLink() ) {
                 //console.debug('#1 ('+process.version+') Found symlink: '+ source,'\n', JSON.stringify(stats, null, 4));
                 try {
@@ -679,7 +745,7 @@ function PathHelper() {
                     e.emit("cp#complete", realPathError, destination);
                     return;
                 }
-                
+
                 e.emit("cp#complete", err, destination)
             } else if ( !stats.isDirectory() ) {
                 // 1) & 2) File => Dir (add if exist else, throw error).
@@ -826,7 +892,7 @@ function PathHelper() {
 //                if (err) {
 //                    logger.error(
 //                        'gina',
-//                        'UTILS:PATH:ERROR:7',
+//                        'LIB:HELPERS:PATH:ERROR:7',
 //                        err,
 //                        __stack
 //                    );
@@ -877,12 +943,12 @@ function PathHelper() {
         list = ( typeof(list) != 'undefined' ) ? list : [];
         listTo = ( typeof(listTo) != 'undefined' ) ? listTo : [];
         i = ( typeof(i) != 'undefined' ) ? i : 0;
-        
+
         //console.debug('[browseCopy]', list.length, i, sourceDir, destinationDir);
         if (
-            sourceDir == undefined 
-            || sourceDir == '' 
-            || destinationDir == undefined 
+            sourceDir == undefined
+            || sourceDir == ''
+            || destinationDir == undefined
             || destinationDir == ''
         ) {
             var copyError = false;
@@ -893,7 +959,7 @@ function PathHelper() {
             end(callback, copyError);
         } else {
             fs.lstat(sourceDir, function(err, stats) {
-                
+
                 if ( stats.isSymbolicLink() ) {
                     //console.debug('real path: ', fs.realpathSync(list[i]));
                     //console.debug('#2 ('+process.version+') Found symlink: '+ sourceDir,'\n', JSON.stringify(stats, null, 4));
@@ -902,7 +968,7 @@ function PathHelper() {
                     } catch (realPathError) {
                         throw realPathError;
                     }
-                    
+
                     ++i;
                     browseCopy(list[i], listTo[i], excluded, callback, list, listTo, i)
                 } else if ( stats.isDirectory() ) {
@@ -1007,7 +1073,7 @@ function PathHelper() {
                         var path = '/'+ (str = source.split(/\//g))[str.length-1];
                         destination += path
                     }
-                    
+
                     exists(destination, function(replaceFlag) {
                         if (replaceFlag) {
                             fs.unlink(destination, function(err) {
@@ -1093,20 +1159,20 @@ function PathHelper() {
                         }
                     })
             }
-        })            
+        })
     }
 
     var mv = function(self, target) {
         console.debug("starting mv/copy from ", self.value, " to ", target);
         cp(self.value, target)
             .onComplete(function onCpMv(err) {
-                console.debug("cp done... now unlinking source ", self.value);        
+                console.debug("cp done... now unlinking source ", self.value);
                 if (err) {
                     e.emit('mv#complete', err);
                     return;
                 }
-    
-                
+
+
                 rm(self.value).onComplete( function(err, path){
                     console.debug('rm() complete');
                     e.emit('mv#complete', err, path)
@@ -1140,14 +1206,18 @@ function PathHelper() {
      *
      * */
     _.prototype.rmSync = function() {
-        
+
         if ( !existsSync(this.value) ) {
             return this // always return the instance for sync
         }
         cleanSlashes(this);
 
         try {
-            
+            // console.debug('rmSync() of ['+ this.value +'] : symlink ? '+ fs.lstatSync(this.value).isSymbolicLink());
+            if ( fs.lstatSync(this.value).isSymbolicLink() ) {
+                fs.unlinkSync(this.value);
+                return this;
+            }
             browseRemoveSync(this.value);
             return this // always return the instance for sync
         } catch (err) {
@@ -1219,7 +1289,7 @@ function PathHelper() {
                 err = removeFileSync(source);
                 if (err instanceof Error)
                     return err;
-                    
+
                 ++i;
                 browseRemoveSync(list[i], list, folders, i)
             } else if ( stats.isDirectory() ) {
@@ -1460,17 +1530,27 @@ function PathHelper() {
         })
     }
 
-    _.prototype.toUnixStyle = function() {
-        var self = this;
+    var toUnixStyle = function(self) {
         var i = _this.paths.indexOf(self.value);
         return ( i > -1 ) ? _this.paths[i].replace(/\\/g, "/") : self.value;
     }
+    _.prototype.toUnixStyle = function() {
+        // var self = this;
+        // var i = _this.paths.indexOf(self.value);
+        // return ( i > -1 ) ? _this.paths[i].replace(/\\/g, "/") : self.value;
+        return toUnixStyle(this)
+    }
 
-    _.prototype.toWin32Style = function() {
-        var self = this;
+    var toWin32Style = function(self) {
         var i = _this.paths.indexOf(self.value);
         return ( i > -1 ) ? _this.paths[i].replace(/\//g, "\\") : self.value;
     }
+    _.prototype.toWin32Style = function() {
+        // var self = this;
+        // var i = _this.paths.indexOf(self.value);
+        // return ( i > -1 ) ? _this.paths[i].replace(/\//g, "\\") : self.value;
+        return toWin32Style(this)
+    }
 
     /**
      * Check if a given path is valid
@@ -1500,7 +1580,7 @@ function PathHelper() {
         }
     }
 
-    
+
 
     var parseCtxObject = function (o, obj) {
 
@@ -1518,12 +1598,12 @@ function PathHelper() {
     /**
      * setPath
      * Set path by name
-     * 
+     *
      * @param {String} name - Path name
      * @returns {String} path
      * */
-    setPath = function(name, path) {        
-        
+    setPath = function(name, path) {
+
         if ( !path || typeof(path) == 'undefined' || path == '' ) {
             throw new Error('setPath(name, path): path cannot be empty or undefined')
         }
@@ -1531,8 +1611,8 @@ function PathHelper() {
         // var stats = fs.lstatSync(path);
         // if (stats instanceof Error) {
         //     throw new stats
-        // }     
-        // if ( stats.isSymbolicLink() ) {            
+        // }
+        // if ( stats.isSymbolicLink() ) {
         //     path = fs.realpathSync(path)
         // }
         var paths = null;

package/framework/{v0.1.1-alpha.19/helpers/json → v0.1.1-alpha.191/helpers/plugins}/package.json

@@ -5,9 +5,9 @@
 
   "author": {
     "name": "Maritn-Luther ETOUMAN",
-    "email": "martinluther@gina.io"
+    "email": "martin-luther@gina.io"
   },
-  "copyright": "Copyright (c) 2009-2022 Rhinostone <contact@gina.io>",
+  "copyright": "Copyright (c) 2009-2023 Rhinostone <contact@gina.io>",
   "engines": {
     "node": ">=0.10.22"
   },