Detect bad option files supplied via --options.

dist/cli/error.js

@@ -234,6 +234,30 @@ Error-handling routines for HackMyResume.
       case HMSTATUS.validateError:
         msg = printf(M2C(this.msgs.validateError.msg), ex.inner.toString());
         etype = 'error';
+        break;
+      case HMSTATUS.invalidOptionsFile:
+        msg = M2C(this.msgs.invalidOptionsFile.msg[0]);
+        if (SyntaxErrorEx.is(ex.inner)) {
+          console.error(printf(M2C(this.msgs.readError.msg, 'red'), ex.file));
+          se = new SyntaxErrorEx(ex, ex.raw);
+          if ((se.line != null) && (se.col != null)) {
+            msg += printf(M2C(this.msgs.parseError.msg[0], 'red'), se.line, se.col);
+          } else if (se.line != null) {
+            msg += printf(M2C(this.msgs.parseError.msg[1], 'red'), se.line);
+          } else {
+            msg += M2C(this.msgs.parseError.msg[2], 'red');
+          }
+        } else if (ex.inner && (ex.inner.line != null) && (ex.inner.col != null)) {
+          msg += printf(M2C(this.msgs.parseError.msg[0], 'red'), ex.inner.line, ex.inner.col);
+        } else {
+          msg += ex;
+        }
+        msg += this.msgs.invalidOptionsFile.msg[1];
+        etype = 'error';
+        break;
+      case HMSTATUS.optionsFileNotFound:
+        msg = M2C(this.msgs.optionsFileNotFound.msg);
+        etype = 'error';
     }
     return {
       msg: msg,

dist/cli/main.js

@@ -62,6 +62,9 @@ Definition of the `main` function.
   main = module.exports = function(rawArgs, exitCallback) {
     var args, initInfo, program;
     initInfo = initialize(rawArgs, exitCallback);
+    if (initInfo === null) {
+      return;
+    }
     args = initInfo.args;
     program = new Command('hackmyresume').version(PKG.version).description(chalk.yellow.bold('*** HackMyResume ***')).option('-s --silent', 'Run in silent mode').option('--no-color', 'Disable colors').option('--color', 'Enable colors').option('-d --debug', 'Enable diagnostics', false).option('-a --assert', 'Treat warnings as errors', false).option('-v --version', 'Show the version').allowUnknownOption();
     program.jsonArgs = initInfo.options;
@@ -104,6 +107,23 @@ Definition of the `main` function.
     var o;
     _exitCallback = exitCallback || process.exit;
     o = initOptions(ar);
+    if (o.ex) {
+      _err.init(false, true, false);
+      if (o.ex.op === 'parse') {
+        _err.err({
+          fluenterror: o.ex.op === 'parse' ? HMSTATUS.invalidOptionsFile : HMSTATUS.optionsFileNotFound,
+          inner: o.ex.inner,
+          quit: true
+        });
+      } else {
+        _err.err({
+          fluenterror: HMSTATUS.optionsFileNotFound,
+          inner: o.ex.inner,
+          quit: true
+        });
+      }
+      return null;
+    }
     o.silent || logMsg(_title);
     if (o.debug) {
       _out.log(chalk.cyan('The -d or --debug switch was specified. DEBUG mode engaged.'));
@@ -173,6 +193,8 @@ Definition of the `main` function.
             inf = safeLoadJSON(optStr);
             if (!inf.ex) {
               oJSON = inf.json;
+            } else {
+              return inf;
             }
           }
         }

dist/cli/msg.yml

@@ -109,3 +109,9 @@ errors:
     msg: Exiting with status code **%s**.
   validateError:
     msg: "An error occurred during validation:\n%s"
+  invalidOptionsFile:
+    msg:
+      - "The specified options file is invalid:\n"
+      - "\nMake sure the options file contains valid JSON."
+  optionsFileNotFound:
+    msg: "The specified options file is missing or inaccessible."

dist/core/fresh-theme.js

@@ -50,7 +50,7 @@ Definition of the FRESHTheme class.
       themeInfo = loadSafeJson(themeFile);
       if (themeInfo.ex) {
         throw {
-          fluenterror: themeInfo.ex.operation === 'parse' ? HMSTATUS.parseError : HMSTATUS.readError,
+          fluenterror: themeInfo.ex.op === 'parse' ? HMSTATUS.parseError : HMSTATUS.readError,
           inner: themeInfo.ex.inner
         };
       }

dist/core/status-codes.js

@@ -33,7 +33,9 @@ Status codes for HackMyResume.
     invalidParamCount: 23,
     missingParam: 24,
     createError: 25,
-    validateError: 26
+    validateError: 26,
+    invalidOptionsFile: 27,
+    optionsFileNotFound: 28
   };
 
 }).call(this);

dist/utils/safe-json-loader.js

@@ -21,7 +21,7 @@ Definition of the SafeJsonLoader class.
     } catch (_error) {
       retRaw = ret.raw && ret.raw.trim();
       ret.ex = {
-        operation: retRaw ? 'parse' : 'read',
+        op: retRaw ? 'parse' : 'read',
         inner: SyntaxErrorEx.is(_error) ? new SyntaxErrorEx(_error, retRaw) : _error,
         file: file
       };

dist/verbs/peek.js

@@ -80,7 +80,7 @@ Implementation of the 'peek' verb for HackMyResume.
     }
     pkgError = null;
     if (obj.ex) {
-      errCode = obj.ex.operation === 'parse' ? HMSTATUS.parseError : HMSTATUS.readError;
+      errCode = obj.ex.op === 'parse' ? HMSTATUS.parseError : HMSTATUS.readError;
       if (errCode === HMSTATUS.readError) {
         obj.ex.quiet = true;
       }

dist/verbs/validate.js

@@ -111,7 +111,7 @@ Implementation of the 'validate' verb for HackMyResume.
           ret.violations = validate.errors;
         }
       } else {
-        if (obj.ex.operation === 'parse') {
+        if (obj.ex.op === 'parse') {
           errCode = HMSTATUS.parseError;
           ret.status = 'broken';
         } else {

src/cli/error.coffee

@@ -226,6 +226,28 @@ assembleError = ( ex ) ->
       msg = printf M2C( @msgs.validateError.msg ), ex.inner.toString()
       etype = 'error'
 
+    when HMSTATUS.invalidOptionsFile
+      msg = M2C @msgs.invalidOptionsFile.msg[0]
+      if SyntaxErrorEx.is ex.inner
+        console.error printf( M2C(this.msgs.readError.msg, 'red'), ex.file )
+        se = new SyntaxErrorEx ex, ex.raw
+        if se.line? and se.col?
+          msg += printf M2C( this.msgs.parseError.msg[0], 'red' ), se.line, se.col
+        else if se.line?
+          msg += printf M2C( this.msgs.parseError.msg[1], 'red' ), se.line
+        else
+          msg += M2C @msgs.parseError.msg[2], 'red'
+      else if ex.inner && ex.inner.line? && ex.inner.col?
+        msg += printf( M2C( this.msgs.parseError.msg[0], 'red' ), ex.inner.line, ex.inner.col)
+      else
+        msg += ex
+      msg += @msgs.invalidOptionsFile.msg[1]
+      etype = 'error'
+
+    when HMSTATUS.optionsFileNotFound
+      msg = M2C( @msgs.optionsFileNotFound.msg )
+      etype = 'error'
+
   msg: msg              # The error message to display
   withStack: withStack  # Whether to include the stack
   quit: quit

src/cli/main.coffee

@@ -40,6 +40,9 @@ process.argv (in production) or custom parameters (in test).
 main = module.exports = ( rawArgs, exitCallback ) ->
 
   initInfo = initialize( rawArgs, exitCallback )
+  if initInfo is null
+    return
+
   args = initInfo.args
 
   # Create the top-level (application) command...
@@ -139,6 +142,16 @@ initialize = ( ar, exitCallback ) ->
 
   _exitCallback = exitCallback || process.exit
   o = initOptions ar
+  if o.ex
+    _err.init false, true, false
+    if( o.ex.op == 'parse' )
+      _err.err
+        fluenterror: if o.ex.op == 'parse' then HMSTATUS.invalidOptionsFile else HMSTATUS.optionsFileNotFound,
+        inner: o.ex.inner,
+        quit: true
+    else
+      _err.err fluenterror: HMSTATUS.optionsFileNotFound, inner: o.ex.inner, quit: true
+    return null
   o.silent || logMsg( _title )
 
   # Emit debug prelude if --debug was specified
@@ -169,7 +182,6 @@ initialize = ( ar, exitCallback ) ->
       , true
     return
 
-
   # Override the .helpInformation behavior
   Command.prototype.helpInformation = ->
     manPage = FS.readFileSync(
@@ -210,6 +222,7 @@ initOptions = ( ar ) ->
       if optStr && (optStr = optStr.trim())
         #var myJSON = JSON.parse(optStr);
         if( optStr[0] == '{')
+          # TODO: remove use of evil(). - hacksalot
           ### jshint ignore:start ###
           oJSON = eval('(' + optStr + ')') # jshint ignore:line <-- no worky
           ### jshint ignore:end ###
@@ -217,7 +230,8 @@ initOptions = ( ar ) ->
           inf = safeLoadJSON( optStr )
           if( !inf.ex )
             oJSON = inf.json
-          # TODO: Error handling
+          else
+            return inf
 
   # Grab the --debug flag, --silent, --assert and --no-color flags
   isDebug = _.some args, (v) -> v == '-d' || v == '--debug'

src/cli/msg.yml

@@ -109,3 +109,9 @@ errors:
     msg: Exiting with status code **%s**.
   validateError:
     msg: "An error occurred during validation:\n%s"
+  invalidOptionsFile:
+    msg:
+      - "The specified options file is invalid:\n"
+      - "\nMake sure the options file contains valid JSON."
+  optionsFileNotFound:
+    msg: "The specified options file is missing or inaccessible."

src/core/fresh-theme.coffee

@@ -43,7 +43,7 @@ class FRESHTheme
     if themeInfo.ex
       throw
         fluenterror:
-          if themeInfo.ex.operation == 'parse'
+          if themeInfo.ex.op == 'parse'
           then HMSTATUS.parseError
           else HMSTATUS.readError
       inner: themeInfo.ex.inner

src/core/status-codes.coffee

@@ -33,3 +33,5 @@ module.exports =
   missingParam: 24
   createError: 25
   validateError: 26
+  invalidOptionsFile: 27
+  optionsFileNotFound: 28

src/utils/safe-json-loader.coffee

@@ -17,7 +17,7 @@ module.exports = ( file ) ->
     # We'll return HMSTATUS.readError or HMSTATUS.parseError.
     retRaw = ret.raw && ret.raw.trim()
     ret.ex =
-      operation: if retRaw then 'parse' else 'read'
+      op: if retRaw then 'parse' else 'read'
       inner:
         if SyntaxErrorEx.is( _error )
         then (new SyntaxErrorEx( _error, retRaw ))

src/utils/syntax-error-ex.coffee

@@ -30,6 +30,7 @@ class SyntaxErrorEx
         @line = (/on line (\d+)/.exec _error)[1]
 
 
-
+# Return true if the supplied parameter is a JavaScript SyntaxError
 SyntaxErrorEx.is = ( ex ) -> ex instanceof SyntaxError
+
 module.exports = SyntaxErrorEx;

src/verbs/peek.coffee

@@ -66,7 +66,7 @@ _peekOne = ( t, objPath ) ->
   ## safeLoadJSON can only return a READ error or a PARSE error
   pkgError = null
   if obj.ex
-    errCode = if obj.ex.operation == 'parse' then HMSTATUS.parseError else HMSTATUS.readError
+    errCode = if obj.ex.op == 'parse' then HMSTATUS.parseError else HMSTATUS.readError
     if errCode == HMSTATUS.readError
       obj.ex.quiet = true
     pkgError = fluenterror: errCode, inner: obj.ex

src/verbs/validate.coffee

@@ -83,7 +83,7 @@ _validateOne = (t, validator, schemas, opts) ->
 
     # If failure, package JSON read/parse errors
     else
-      if obj.ex.operation == 'parse'
+      if obj.ex.op == 'parse'
         errCode = HMSTATUS.parseError
         ret.status = 'broken'
       else

test/scripts/hmr-options-broken.json

@@ -0,0 +1,10 @@
+{
+  // Set the default theme to "compact"
+  //"theme": "node_modules/jsonresume-theme-elegant",
+  //"theme": "jsonresume-theme-elegant",
+  "theme": "elegant",
+  // Change the "employment" section title text to "Work"
+  "sectionTitles": {
+    "employment": "Work"
+  }
+}

test/scripts/test-output.js

@@ -143,9 +143,36 @@ describe('Testing Ouput interface', function () {
         'to',
         'test/sandbox/temp/janeq-3.all',
         '--options',
-        "test/hmr-options.json",
+        "test/scripts/hmr-options.json",
         "-t",
         "modern"
       ],
       [ 'Applying MODERN theme'] );
+
+  run('HMR should detect a missing or inaccessible options file',
+      [
+        'build',
+        'doesntmatter.json',
+        'to',
+        'dontcare.all',
+        '--options',
+        "test/scripts/hmr-options-nonexistent.json",
+        "-t",
+        "modern"
+      ],
+      [ 'The specified options file is missing or inaccessible'] );
+
+  run('HMR should detect an invalid or malformed options file',
+      [
+        'build',
+        'doesntmatter.json',
+        'to',
+        'dontcare.all',
+        '--options',
+        "test/scripts/hmr-options-broken.json",
+        "-t",
+        "modern"
+      ],
+      [ 'The specified options file is invalid'] );
+
 });