gina 0.1.1-alpha.15 → 0.1.1-alpha.151

package/script/prepare_version.js

@@ -39,11 +39,48 @@ var lib         = null;
  * @constructor
  * */
 function PrepareVersion() {
-    var self    = {};
+    var self    = {
+        isWin32: isWin32(),
+        git : {
+            tag: 'latest',
+            msg: null
+        },
+        isGitPushNeeded : false
+    };
+
+    var configure = function() {
+        // TODO - handle windows case
+        if ( /^true$/i.test(isWin32()) ) {
+            throw new Error('Windows in not yet fully supported. Thank you for your patience');
+        }
+
+        // Overriding thru passed arguments
+        var args = process.argv, i = 0, len = args.length;
+        for (; i < len; ++i) {
+            if ( /^\-\-tag/.test(args[i]) ) {
+                var tag = args[i].split(/\=/)[1];
+                if ( tag != self.git.tag) {
+                    self.git.tag = tag;
+                    self.isGitPushNeeded = ( typeof(process.env.npm_config_dry_run) != 'undefined' ) ? false : true
+                }
+                continue;
+            }
+
+            if ( /^(\-m|\-\-message)$/.test(args[i]) ) {
+                var m = args[i];
+                if (/^(.*)\=/.test(m)) {
+                    m = m.split(/\=/)[1]
+                }
+                self.git.msg = m.replace(/^(\-m|\-\-message)/g, '').replace(/(\"|\')/g, '');
+                continue;
+            }
+        }
+
+        self.gina = __dirname +'/..';
+    }
 
     var init = function() {
-        self.isWin32    = isWin32();
-        self.prefix     = execSync('npm config get prefix');
+        configure();
 
         begin(0);
     };
@@ -267,7 +304,7 @@ function PrepareVersion() {
         var versionsFolders = null, frameworkPath = null;
         try {
             frameworkPath = _(self.ginaPath +'/framework', true);
-            console.info('frameworkPath: ', frameworkPath);
+            console.debug('frameworkPath: ', frameworkPath);
             if ( !new _(frameworkPath).existsSync() ) {
                 return done();
             }
@@ -296,7 +333,8 @@ function PrepareVersion() {
         done();
     }
 
-    self.pushChangesToGit = function(done) {
+
+    self.pushChangesToGitIfNeeded = function(done) {
 
         var cmd = null;
         var version = self.selectedVersion.replace(/^[a-z]+/ig, '');
@@ -317,7 +355,10 @@ function PrepareVersion() {
 
         // create new branch if needed
         // e.g: 0.1.0-alpha.1 -> 010-alpha1
-        var targetedBranch = version.replace(/\./g, '');
+        var targetedBranch = version.replace(/\./g, ''); // by default
+        if (!self.isGitPushNeeded) {
+            targetedBranch = 'develop'; // for none production versions
+        }
         self.targetedBranch = targetedBranch;
 
         console.debug('[GIT] Current branch: '+ currentBranch);
@@ -335,13 +376,16 @@ function PrepareVersion() {
             // nothing to do
         }
 
+
         if (!branchExists) {
             console.debug('No existing branch found, creating a new one !');
             try {
                 execSync("git checkout -b "+ targetedBranch);
-                // pushing to new branch
-                console.debug('setting up remote branch `'+ targetedBranch +'` to git ...');
-                execSync("git push --set-upstream origin "+ targetedBranch);
+                if (self.isGitPushNeeded) {
+                    // pushing to new branch
+                    console.debug('setting up remote branch `'+ targetedBranch +'` to git ...');
+                    execSync("git push --set-upstream origin "+ targetedBranch);
+                }
             } catch (err) {
                 console.error(err.stack||err.message||err);
                 return done(err);
@@ -364,8 +408,7 @@ function PrepareVersion() {
             }
         }
 
-
-        // git add --all
+        // commit changes
         try {
             cmd = execSync("git add --all ");
         } catch (err) {
@@ -375,29 +418,38 @@ function PrepareVersion() {
         }
         // git commit -m'Packaging version v'+ version
         try {
-            var msg = (!branchExists) ? 'New version' : 'Prerelease update - '+ new Date().format("isoDateTime");
+            var msg = (!branchExists) ? 'New version' : 'Prerelease update'; //+ new Date().format("isoDateTime");
+            if (self.git.msg) {
+                msg += ' - '+ self.git.msg
+            }
             cmd = execSync("git commit -am'"+ msg +"'");
         } catch (err) {
-            if (!/Your branch is up to date/i.test( err.output.toString() )) {
+            if (!/Your branch is up to date|nothing to commit, working tree clean/i.test( err.output.toString() )) {
                 console.error(err.stack||err.message||err);
                 return done(err);
             }
         }
 
-        console.debug('Pushing changes made on branch `'+ targetedBranch +'` to git `origin/'+ targetedBranch +'`');
-        // git push origin 010
-        try {
-            cmd = execSync("git push origin "+ targetedBranch );
-        } catch (err) {
-            if (!/Everything up-to-date/i.test( err.output.toString() )) {
-                console.error(err.stack||err.message||err);
-                return done(err);
+        if (self.isGitPushNeeded) {
+            console.debug('Pushing changes made on branch `'+ targetedBranch +'` to git `origin/'+ targetedBranch +'`');
+            // git push origin 010
+            try {
+                cmd = execSync("git push origin "+ targetedBranch );
+                // set tag version & tag ?
+            } catch (err) {
+                if (!/Everything up-to-date/i.test( err.output.toString() )) {
+                    console.error(err.stack||err.message||err);
+                    return done(err);
+                }
             }
         }
 
         done()
     }
 
+
+
+
     // self.tagVersionIfNeeded = function(done) {
     //     // check if script is on Dry Run !!!
     //     if ( typeof(process.env.npm_config_dry_run) != 'undefined' ) {
@@ -418,6 +470,84 @@ function PrepareVersion() {
     // }
 
 
+    var restoreSymlinks = function(done) {
+
+        if ( typeof(process.env.npm_config_dry_run) == 'undefined' || !process.env.npm_config_dry_run ) {
+            // ignoring for now, after publishing completion
+            return
+        }
+        var archivesPath = _(getUserHome() + '/.gina/archives/framework', true);
+        var frameworkPath = _(self.gina +'/framework', true);
+
+        if ( !new _(archivesPath).existsSync() ) {
+            return;
+        }
+        // get current framework version
+        var package = require(pack);
+        var currentVersion = 'v'+ package.version.replace(/^v/, '');
+
+        // cleanup first
+        var versionsFolders = fs.readdirSync(frameworkPath);
+        for (let i = 0, len = versionsFolders.length; i < len; i++) {
+            let dir = versionsFolders[i];
+            // skip junk
+            if ( /^\./i.test(dir) || /(\s+copy|\.old)$/i.test(dir) ) {
+                continue;
+            }
+
+            // intercept & remove existing symlinks or old versions dir
+            try {
+                if ( fs.lstatSync( _(frameworkPath +'/'+ dir, true) ).isSymbolicLink() ) {
+                    console.debug('Removing Symlink: '+ _(frameworkPath +'/'+ dir, true) );
+                    // new _(frameworkPath +'/'+ dir, true).rmSync();
+                    fs.unlinkSync(_(frameworkPath +'/'+ dir, true));
+                    continue;
+                }
+
+                if (
+                    dir != currentVersion
+                    && fs.lstatSync( _(frameworkPath +'/'+ dir, true) ).isDirectory()
+                ) {
+                    console.debug('Removing old version: '+ _(frameworkPath +'/'+ dir, true));
+                    new _(frameworkPath +'/'+ dir, true).rmSync()
+                }
+            } catch (e) {
+                continue;
+            }
+        }
+
+        // restoring symlinks from archives
+        versionsFolders = fs.readdirSync(archivesPath);
+        for (let i = 0, len = versionsFolders.length; i < len; i++) {
+            let dir = versionsFolders[i];
+            // skip junk
+            if ( /^\./i.test(dir) || /(\s+copy|\.old)$/i.test(dir) ) {
+                continue;
+            }
+
+            // skip selected - for dev team only
+            if ( new _(frameworkPath +'/'+ dir, true).existsSync() ) {
+                continue;
+            }
+
+            // creating symlinks
+            try {
+                console.debug( 'Creating symlink: '+ _(archivesPath +'/'+ dir, true) +' -> '+ _(frameworkPath +'/'+ dir, true));
+                new _(archivesPath +'/'+ dir, true).symlinkSync(_(frameworkPath +'/'+ dir, true) );
+            } catch (e) {
+                return done(e)
+            }
+        }
+    }
+
+    self.end = function(done) {
+
+        // restoreSymlinks(done);
+
+        done()
+    }
+
+
 
     init()
 }

package/utils/helper.js

@@ -1,5 +1,6 @@
 var fs = require('fs');
 var os = require('os');
+const { execSync } = require('child_process');
 
 var lib         = null;
 var console     = null;
@@ -25,18 +26,45 @@ function MainHelper(opt) {
         var packObj = require(pack);
         var version =  getEnvVar('GINA_VERSION') || packObj.version;
         var frameworkPath = ginaPath + '/framework/v' + version;
-        
+        var pkg = null, cmd = null, prefix = null;
+        self.isGlobalInstall = getEnvVar('GINA_GLOBAL_MODE') || ( typeof(packObj.config) != 'undefined' && typeof(packObj.config.globalMode) != 'undefined' ) ? packObj.config.globalMode : true;
         try {
-            lib         = require(frameworkPath + '/lib');
-            console     = lib.logger;
-            merge       = lib.merge;
+            // TODO - remove this code: it is creating a circular dependency
+            // lib         = require(frameworkPath + '/lib');
+            // console     = lib.logger;
+            // merge       = lib.merge;
+
+            console = require(frameworkPath + '/lib/logger');
+            merge   = require(frameworkPath + '/lib/merge');
+
+            try {
+                pkg = packObj;
+                self.defaultPrefix = ( typeof(packObj.config) != 'undefined' && typeof(packObj.config.prefix) != 'undefined' ) ? packObj.config.prefix : execSync('npm config get prefix').toString().replace(/\n$/g, '');
+                self.defaultPrefix = self.defaultPrefix.replace(/^\~/, getUserHome());
+                prefix = getEnvVar('GINA_PREFIX') || self.defaultPrefix;
+                self.optionalPrefix = pkg.config.optionalPrefix.replace(/^\~/, getUserHome());
+            } catch(err) {
+                console.warn('MainHelper::Init() Execption: '+ err.stack);
+                console.debug('Trying alternative config');
+                try {
+                    self.defaultPrefix = execSync('npm config get prefix').toString().replace(/\n$/g, '');
+                    prefix = getEnvVar('GINA_PREFIX') || self.defaultPrefix;
+                    cmd = 'npm list gina --long --json --prefix='+ prefix;
+                    if (self.isGlobalInstall) {
+                        cmd += ' -g';
+                    }
+                    pkg = execSync(cmd).toString().replace(/\n$/g, '');
+                    self.optionalPrefix = JSON.parse(pkg).dependencies.gina.config.optionalPrefix.replace(/^\~/, getUserHome());
+                } catch (_err) {
+                    throw new Error(_err.stack +'\n'+ err.stack)
+                }
+            }
+
         } catch (err) {
             // this can happen in certain conditions
             // like scripts running out of the framework context
             // we'll just ignore it
         }
-        
-        
     }
 
     /**
@@ -199,7 +227,7 @@ function MainHelper(opt) {
         }
 
         var newArgv = {};
-        for (var a in process.argv) {            
+        for (var a in process.argv) {
             if ( /\-\-/.test(process.argv[a]) && process.argv[a].indexOf('=') > -1 ) {
                 evar = ( (process.argv[a].replace(/--/, ''))
                     .replace(/-/, '_') )
@@ -254,6 +282,12 @@ function MainHelper(opt) {
         setContext('envVars', process['gina']);
     }
 
+    /**
+     * getEnvVar
+     * Will read from `process.gina` which is set mostly in `cli.js`
+     *
+     * @param {string} key
+     */
     getEnvVar = function(key) {
         if (
             typeof(process['gina']) != 'undefined' &&
@@ -269,6 +303,10 @@ function MainHelper(opt) {
         return process.gina
     }
 
+    getProtected = function() {
+        return self.protectedVars
+    }
+
     /**
      * Get log path - %SystemRoot%\system32\winevt\logs or /
      *
@@ -277,37 +315,74 @@ function MainHelper(opt) {
     getLogDir = function() {
         // Trying to retrieve original value if already defined
         var logDir = getEnvVar('GINA_LOGDIR') || null;
+        var logDirObj = null;
         if ( logDir ) {
-            if ( !/gina$/.test(logDir) ) {
-                logDir += ( isWin32() ) ? '\\gina' : '/gina'
+            logDirObj = new _(logDir, true);
+            if ( !logDirObj.existsSync() ) {
+                logDirObj.mkdirSync()
             }
             return logDir
         }
+
+        var prefix = getEnvVar('GINA_PREFIX') || self.prefix || self.defaultPrefix || execSync('npm config get prefix').toString().replace(/\n$/g, '');
+
         if ( isWin32() ) {
             logDir = process.env.LOG ||
                 process.env.LOGS ||
                 (process.env.SystemRoot || process.env.windir) + '\\System32\\Winevt\\Logs'
             ;
+
+            if ( !logDir || logDir == '' ) {
+                throw new Error('Log directory not defined or not found !');
+            }
+
+            logDirObj = new _(logDir);
+            if ( !logDirObj.isWritableSync() ) {
+                throw new Error('Log directory found but not writable: need permissions for `'+ logDir +'`');
+            }
+
             if ( !/gina$/.test(logDir) ) {
-                logDir += '\\gina'
+                logDir += '\\gina';
+                logDirObj = new _(logDir);
             }
         } else {
             logDir = process.env.LOGDIR ||
                 process.env.LOG ||
                 process.env.LOGS ||
-                '/usr/local/var/log'
+                prefix+'/var/log'
             ;
-            if ( !/gina$/.test(logDir) ) {
-                logDir += '/gina'
+            logDirObj = new _(logDir);
+            if ( new RegExp('^'+ prefix).test(logDir) && !new _(prefix).isWritableSync() ) {
+                logDir = getUserHome() +'/.gina/log';
+                logDirObj = new _(logDir);
+                if ( !logDirObj.existsSync() ) {
+                    logDirObj.mkdirSync()
+                }
+
+                return logDir
+            }
+
+            if ( new RegExp('^'+ prefix +'/var').test(logDir) && !new _(prefix +'/var').existsSync() ) {
+                fs.mkdirSync(prefix +'/var');
+            }
+
+            if ( !logDirObj.existsSync() ) {
+                logDirObj.mkdirSync();
+            }
+
+            if ( !/gina$/.test(logDir) && self.optionalPrefix != prefix ) {
+                logDir += '/gina';
+                logDirObj = new _(logDir);
             }
         }
-        
+
+        if ( !logDirObj.existsSync() ) {
+            logDirObj.mkdirSync()
+        }
+
         return logDir;
     }
 
-    getProtected = function() {
-        return self.protectedVars
-    }
 
     /**
      * Get run\lock path
@@ -316,46 +391,157 @@ function MainHelper(opt) {
     getRunDir = function() {
         // Trying to retrieve original value if already defined
         var runDir = getEnvVar('GINA_RUNDIR') || null;
+        var runDirObj = null;
         if ( runDir ) {
-            if ( !/gina$/.test(runDir) ) {
-                runDir += ( isWin32() ) ? '\\gina' : '/gina'
+            runDirObj = new _(runDir, true);
+            if ( !runDirObj.existsSync() ) {
+                runDirObj.mkdirSync()
             }
             return runDir
         }
-        
-        if ( isWin32() ) {
-            console.debug('check /gina/utils/helper.js around on getRunDir()')
-        } else {                        
-            // Means `/usr/local/var/lock` or `/usr/local/var/run` by default.
-            runDirObj = new _('/usr/local/var/lock', true);
-            if ( runDirObj.existsSync() ) {
-                return _( runDirObj.toUnixStyle() +'/gina', true );
+
+        var prefix = getEnvVar('GINA_PREFIX') || self.prefix || self.defaultPrefix || execSync('npm config get prefix').toString().replace(/\n$/g, '');
+
+        runDir = (isWin32()) ? getUserHome() + '\\.gina\\run' : prefix + '/var/lock';
+
+        if ( !isWin32() && new RegExp('^'+ prefix).test(runDir) && !new _(prefix).isWritableSync() ) {
+            runDir = getUserHome() +'/.gina/run';
+            runDirObj = new _( runDir, true );
+            if ( !runDirObj.existsSync() ) {
+                runDirObj.mkdirSync()
+            }
+
+            return runDir
+        }
+
+
+        runDirObj = new _( runDir, true );
+        if ( runDirObj.existsSync() ) {
+            if ( !runDirObj.isWritableSync() ) {
+                throw new Error('location `'+ runDir +'` found but not writable !' )
+            }
+
+            runDir += ( isWin32() ) ? '' : '/gina';
+            runDirObj = new _( runDir, true );
+            if ( !runDirObj.existsSync() ) {
+                runDirObj.mkdirSync()
+            }
+
+            return runDir;
+        }
+
+        try {
+            if ( new RegExp('^'+ prefix +'/var').test(runDir) && !new _(prefix + '/var').existsSync() ) {
+                fs.mkdirSync(prefix +'/var');
+            }
+
+            runDir = prefix +'/var/run';//by default.
+            if ( !existsSync(runDir) ) {
+                fs.mkdirSync(runDir)
+            }
+        } catch (err) {
+            throw new Error('location error: `'+ runDir+'`\n'+ err.stack);
+        }
+
+        if (self.optionalPrefix != prefix) {
+            runDir += ( isWin32() ) ? '\\gina' : '/gina';
+            runDirObj = new _( runDir, true );
+            if ( !runDirObj.existsSync() ) {
+                fs.mkdirSync(runDir)
             }
-            // by default
-            return _('/usr/local/var/run/gina', true)//by default.
         }
+
+        return runDir;
     }
 
     getTmpDir = function() {
+
+        var dir = getEnvVar('GINA_TMPDIR') || null;
+        if (dir) {
+            dirObj = new _(dir, true);
+            if ( !dirObj.existsSync() ) {
+                dirObj.mkdirSync()
+            }
+            return dir
+        }
+
+        var prefix = getEnvVar('GINA_PREFIX') || self.prefix  || self.defaultPrefix || execSync('npm config get prefix').toString().replace(/\n$/g, '');
+
         // support for node 0.10.x & 0.11.x
-        var tmp = os.tmpdir || function() {
+        var tmp = (os.tmpdir) ? os.tmpdir : function() {
+            var tmpDir = null;
             if ( isWin32() ) {
-                return process.env.TEMP ||
+                tmpDir = process.env.TEMP ||
                     process.env.TMP ||
                     (process.env.SystemRoot || process.env.windir) + '\\Temp'
             } else {
-                return process.env.TMPDIR ||
+                tmpDir = process.env.TMPDIR ||
                     process.env.TMP ||
                     process.env.TEMP ||
-                    '/usr/local/var/tmp'
+                    prefix+'/var/tmp'
+                ;
+
+                if ( new RegExp('^'+ prefix).test(tmpDir) && !isWritableSync(prefix) ) {
+                    tmpDir = getUserHome() +'/.gina/tmp';
+                    if ( !existsSync(tmpDir) ) {
+                        fs.mkdirSync(tmpDir)
+                    }
+                }
+
+                if ( new RegExp('^'+ prefix +'/var').test(tmpDir) && !existsSync(prefix +'/var') ) {
+                    fs.mkdirSync(prefix +'/var');
+                }
+            }
+
+            var tmpDirObj = new _(tmpDir);
+            if ( !tmpDirObj.existsSync() ) {
+                tmpDirObj.mkdirSync();
             }
         };
 
-        return ( typeof(tmp) == 'function') ?  tmp() : tmp
+        return tmp()
     }
 
+    /**
+     * isWritableSync
+     * Only used for `getUserHome()`
+     *
+     * @param {string} path
+     */
+    var isWritableSync = function(path) {
+        var canWrite = false;
+        if ( typeof(fs.accessSync) != 'undefined' ) {
+            try {
+                fs.accessSync(path, fs.constants.W_OK);
+                canWrite = true;
+            } catch (err) {
+                canWrite = false;
+            }
+        } else { // support for old version of nodejs
+
+            try {
+                canWrite = (fs.statSync(path).mode & (fs.constants.S_IRUSR | fs.constants.S_IRGRP | fs.constants.S_IROTH));
+            } catch (err) {
+                canWrite = false
+            }
+        }
+
+        return canWrite
+    };
+
     getUserHome = function() {
-        return process.env[(isWin32()) ? 'USERPROFILE' : 'HOME']
+        var homeDir = process.env[(isWin32()) ? 'USERPROFILE' : 'HOME'];
+
+        if ( !homeDir || homeDir == '' ) {
+            throw new Error('Home directory not defined or not found !');
+        }
+
+
+        if ( !isWritableSync(homeDir) ) {
+            throw new Error('Home directory found but not writable: need permissions for `'+ homeDir +'`');
+        }
+
+        return homeDir
     }
 
     getVendorsConfig = function(vendor) {
@@ -387,14 +573,14 @@ function MainHelper(opt) {
         }
     }
 
-    setEnvVar = function(key, val, isProtected) {        
+    setEnvVar = function(key, val, isProtected) {
         key = key.toUpperCase();
         var err                     = null
-            // related task `framework:set` & framework/v.xxx/lib/cmd/framework/init.js 
+            // related task `framework:set` & framework/v.xxx/lib/cmd/framework/init.js
             , specialCases          = ['GINA_PORT', 'GINA_DEBUG_PORT', 'GINA_CULTURE', 'GINA_TIMEZONE']
             , isOverrrideAllowed    = (specialCases.indexOf(key) > -1) ? true : false
         ;
-        
+
         if (
             key.substr(0, 5) !== 'GINA_' &&
             key.substr(0, 7) !== 'VENDOR_' &&
@@ -418,10 +604,10 @@ function MainHelper(opt) {
                 process['gina'] = {}
             }
             process['gina'][key] = val;
-            if ( typeof(isProtected) != 'undefined' && isProtected == true) {                
+            if ( typeof(isProtected) != 'undefined' && isProtected == true) {
                 self.protectedVars.push(key)
-            }            
-        }        
+            }
+        }
     }
 
     defineDefault = function(obj) {
@@ -429,10 +615,10 @@ function MainHelper(opt) {
             define(c, obj[c])
         }
         delete  obj
-    }
+    }// jshint ignore:line
 
     init(opt)
 
-};
+}
 
-module.exports = MainHelper()
+module.exports = MainHelper();