true 2.1.3 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6a3b24624df5c06f4fcdb1da05e91c508e43d1f
-  data.tar.gz: dc4fbcdbd8bd5e8ad8d33a4354ee8eacb94e1312
+  metadata.gz: 43b01a67a1a718450d44cbfde4148435092d885e
+  data.tar.gz: 2a9662ae8300f2983a2de95e1eb5555a3b5f6138
 SHA512:
-  metadata.gz: f0bc90f7aecd98a9fcf877487c13cfccff8b5ef1617d37e86e44b82d412e3f63b9f5199cd743ffa44df248845339252cbc6d059605928e6627f7cfe2bfba8768
-  data.tar.gz: 1dfa2bcd589cdb764dda6720c0cf0dd3fdc244c2831e62d215df77c6b579cb0b6fb7fd1fb2227fc0bdc8f10be16d3f436988ce9c3f70b0bd94ba0dcc150c377a
+  metadata.gz: aad2c6319c983bad8e96b4364c936d7f0f18a2a3ad2aae8ff5e042fe0f9cdebf873079b9074f65681a2f4b9ca4a7c618d9d46a6b777559999fc9e3e86dd2dba9
+  data.tar.gz: b62531759187d5970e96fd946df5e1031e43bd0c9e3384f25184c9ad1243aa5eefdf4649c429dd40d531aef7284cf52568e9e9db3c380fef9e596dcd56d4663b

data/CHANGELOG.md

@@ -2,6 +2,23 @@ True Changelog
 ==============
 
 
+2.2.0 UNRELEASED
+----------------
+- Output CSS context around Mocha parsing errors.
+- Added `$fail-on-error` argument to `report()` mixin.
+  Set to `true` if you need the Sass compiler to fail
+  on broken tests.
+- Fix bug with `assert-false` causing it to fail on `null` values.
+- Allow unquoted descriptions and test/module names.
+- Fix bug throwing off test-count and reporting.
+
+
+2.1.4 (12/22/16)
+----------------
+- Fix default assertion messages
+- Upgrade dependencies
+
+
 2.0.2 (5/13/15)
 ---------------
 - Fixes debug inspector.

data/README.md

@@ -1,5 +1,4 @@
-True
-====
+# True
 
 [![Build Status](https://api.travis-ci.org/oddbird/true.svg)](https://travis-ci.org/oddbird/true)
 
@@ -13,8 +12,7 @@ True
   *True your sweet plugin before you deploy.*
 
 
-Install
--------
+## Install
 
 in command line:
 
@@ -30,11 +28,9 @@ npm install sass-true
 ```
 
 
-Usage
------
+## Usage
 
-With any Sass compiler
-~~~~~~~~~~~~~~~~~~~~~~
+### With any Sass compiler
 
 ```scss
 @import "true";
@@ -85,8 +81,7 @@ in the output code.
 Version control can make that much easier than it sounds.
 
 
-With node-sass and Mocha (or other JS test runners)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+### With node-sass and Mocha (or other JS test runners)
 
 1. Install `true` via npm (`npm install sass-true`).
 
@@ -94,7 +89,7 @@ With node-sass and Mocha (or other JS test runners)
 
 3. Write a shim JS test file in `test/test_sass.js`:
 
-   ```js
+   ```javascript
    var path = require('path');
    var sassTrue = require('sass-true');
 
@@ -116,6 +111,12 @@ Any other JS test runner with equivalents to Mocha's `describe` and `it` should
 be usable in the same way; just pass your test runner's `describe` and `it`
 equivalents into `runSass`.
 
+If True's Mocha plugin can't parse the CSS output from True, it'll give you
+some context lines of CSS as part of the error message. This context will
+likely be helpful in understanding the parse failure. By default it provides up
+to 10 lines of context; if you need more, you can provide a numeric fourth
+argument to `runSass`, the maximum number of context lines to provide.
+
 
 #### With Grunt...
 
@@ -124,7 +125,7 @@ Run Mocha using the Grunt task supplied by
 
 Install `grunt-mocha-cli`:
 
-```
+```bash
 npm install grunt-mocha-cli --save-dev
 ```
 
@@ -144,18 +145,17 @@ Run tests:
 grunt mochacli
 ```
 
-
-With ruby-sass on the command line
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+### With ruby-sass on the command line
 
 ```bash
 true-cli [options] PATH
 ```
 
 Options:
-* `-s` silent
-* `-c` config file
-* `-d` debug config file settings
+
+ * `-s` silent
+ * `-c` config file
+ * `-d` debug config file settings
 
 Config file (optional):
 
@@ -166,14 +166,13 @@ options:
 # require ruby sass extension libraries
 require:
   - "compass"
-  - "serialy_sassy"
+  - "serialy/sassy"
 ```
 
 default location: `test/true.yml`
 
 
-Settings
---------
+## Settings
 
 There is only one setting:
 `$true-terminal-output`

data/VERSION

@@ -1 +1 @@
-2.1.2
+2.2.0

data/lib/main.js

@@ -24,7 +24,7 @@ var EXPECTED_START_TOKEN = 'EXPECTED';
 var EXPECTED_END_TOKEN = 'END_EXPECTED';
 var ASSERT_END_TOKEN = 'END_ASSERT';
 
-module.exports.runSass = function (options, describe, it) {
+module.exports.runSass = function (options, describe, it, contextLines) {
   var sassPath = path.join(__dirname, '..', 'sass');
   if (options.includePaths) {
     options.includePaths.push(sassPath);
@@ -32,7 +32,7 @@ module.exports.runSass = function (options, describe, it) {
     options.includePaths = [sassPath];
   }
   var css = sass.renderSync(options).css.toString();
-  var modules = parse(css);
+  var modules = parse(css, contextLines);
 
   _.each(modules, function (module) {
     describeModule(module, describe, it);
@@ -70,212 +70,227 @@ var describeModule = function (module, describe, it) {
 };
 
 
-var parse = module.exports.parse = function (rawCss) {
-  var ast = css.parse(rawCss);
-  var ctx = { modules: [] };
-  var handler = parseModule;
-
-  _.each(ast.stylesheet.rules, function (rule) {
-    handler = handler(rule, ctx);
-  });
-
-  finishCurrentModule(ctx);
-
-  return ctx.modules;
-};
+var parse = module.exports.parse = function (rawCss, contextLines) {
+  var contextLines = (typeof contextLines === 'undefined') ? 10 : contextLines;
+  var lines = rawCss.split(/\r?\n/);
 
+  var parseCss = function () {
+    var ast = css.parse(rawCss);
+    var ctx = { modules: [] };
+    var handler = parseModule;
 
-var parseError = function (msg, seeking, pos) {
-  return new Error(
-    'Line ' + pos.start.line + ', ' +
-    'column ' + pos.start.column + ': ' +
-    msg + '; ' +
-    'looking for ' + seeking
-  );
-}
+    _.each(ast.stylesheet.rules, function (rule) {
+      handler = handler(rule, ctx);
+    });
 
+    finishCurrentModule(ctx);
 
-var parseModule = function (rule, ctx) {
-  if (rule.type === 'charset') { return parseModule; }
-  if (rule.type === 'comment') {
-    var text = rule.comment.trim();
-    if (!text) { return parseModule; }
-    if (startsWith(text, MODULE_TOKEN)) {
-      finishCurrentModule(ctx);
-      ctx.currentModule = { module: text.substring(MODULE_TOKEN.length), tests: [] };
-      return parseTest;
-    }
-    if (startsWith(text, SUMMARY_TOKEN)) {
-      return ignoreUntilEndSummary;
-    }
-    // ignore un-recognized comments, keep looking for module header.
-    return parseModule;
+    return ctx.modules;
   }
-  throw parseError('Unexpected rule type "' + rule.type + '"', 'module header', rule.position);
-};
 
 
-var ignoreUntilEndSummary = function (rule, ctx) {
-  if (rule.type === 'comment') {
-    var text = rule.comment.trim();
-    if (startsWith(text, END_SUMMARY_TOKEN)) {
-      return parseModule;
-    }
-    return ignoreUntilEndSummary;
+  var parseError = function (msg, seeking, pos) {
+    return new Error(
+      'Line ' + pos.start.line + ', ' +
+        'column ' + pos.start.column + ': ' +
+        msg + '; ' +
+        'looking for ' + seeking + '.\n' +
+        '-- Context --\n' +
+        lines.slice(
+          Math.max(0, pos.start.line - contextLines),
+          pos.start.line
+        ).join('\n') + '\n' +
+        (' '.repeat(pos.start.column - 1)) + '^\n'
+    );
   }
-  throw parseError('Unexpected rule type "' + rule.type + '"', 'end summary', rule.position);
-};
 
 
-var parseTest = function (rule, ctx) {
-  if (rule.type === 'comment') {
-    var text = rule.comment.trim();
-    if (!text) { return parseTest; }
-    if (text.match(/^-+$/)) {
-      return parseTest;
-    }
-    if (startsWith(text, TEST_TOKEN)) {
-      finishCurrentTest(ctx);
-      ctx.currentTest = { test: text.substring(TEST_TOKEN.length), assertions: [] };
-      return parseAssertion;
+  var parseModule = function (rule, ctx) {
+    if (rule.type === 'charset') { return parseModule; }
+    if (rule.type === 'comment') {
+      var text = rule.comment.trim();
+      if (!text) { return parseModule; }
+      if (startsWith(text, MODULE_TOKEN)) {
+        finishCurrentModule(ctx);
+        ctx.currentModule = { module: text.substring(MODULE_TOKEN.length), tests: [] };
+        return parseTest;
+      }
+      if (startsWith(text, SUMMARY_TOKEN)) {
+        return ignoreUntilEndSummary;
+      }
+      // ignore un-recognized comments, keep looking for module header.
+      return parseModule;
     }
-    return parseModule(rule, ctx);
-  }
-  throw parseError('Unexpected rule type "' + rule.type + '"', 'test', rule.position);
-};
+    throw parseError('Unexpected rule type "' + rule.type + '"', 'module header', rule.position);
+  };
 
 
-var parseAssertion = function (rule, ctx) {
-  if (rule.type === 'comment') {
-    var text = rule.comment.trimLeft();
-    if (!text) { return parseAssertion; }
-    if (startsWith(text, PASS_TOKEN)) {
-      finishCurrentAssertion(ctx);
-      ctx.currentAssertion = {
-        description: text.substring(PASS_TOKEN.length).trim() || '<no description>',
-        passed: true
-      };
-      return parseAssertion;
-    } else if (startsWith(text, FAIL_TOKEN)) {
-      finishCurrentAssertion(ctx);
-      var endAssertionType = text.indexOf(END_FAIL_TOKEN);
-      ctx.currentAssertion = {
-        description: text.substring(endAssertionType + 2).trim(),
-        passed: false,
-        assertionType: text.substring(FAIL_TOKEN.length, endAssertionType).trim(),
-      };
-      return parseFailureDetail;
-    } else if (startsWith(text, ASSERT_TOKEN)) {
-      finishCurrentAssertion(ctx);
-      ctx.currentAssertion = {
-        description: text.substring(ASSERT_TOKEN.length).trim(),
-        assertionType: 'equal'
-      };
-      return parseAssertionOutputStart;
+  var ignoreUntilEndSummary = function (rule, ctx) {
+    if (rule.type === 'comment') {
+      var text = rule.comment.trim();
+      if (startsWith(text, END_SUMMARY_TOKEN)) {
+        return parseModule;
+      }
+      return ignoreUntilEndSummary;
     }
-    return parseTest(rule, ctx);
-  }
-  throw parseError('Unexpected rule type "' + rule.type + '"', 'assertion', rule.position);
-}
+    throw parseError('Unexpected rule type "' + rule.type + '"', 'end summary', rule.position);
+  };
 
 
-var parseFailureDetail = function (rule, ctx) {
-  if (rule.type === 'comment') {
-    var text = rule.comment.trim();
-    if (startsWith(text, FAILURE_DETAIL_TOKEN)) {
-      var startType = text.indexOf(FAILURE_TYPE_START_TOKEN);
-      var endType = text.indexOf(FAILURE_TYPE_END_TOKEN);
-      var type = text.substring(startType, endType + 1);
-      var content = text.substring(endType + 3);
-      var outputOrExpected;
-      if (text.substring(FAILURE_DETAIL_TOKEN.length, startType) === OUTPUT_TOKEN) {
-        outputOrExpected = 'output';
-      } else if (text.substring(FAILURE_DETAIL_TOKEN.length, startType) === EXPECTED_TOKEN) {
-        outputOrExpected = 'expected';
+  var parseTest = function (rule, ctx) {
+    if (rule.type === 'comment') {
+      var text = rule.comment.trim();
+      if (!text) { return parseTest; }
+      if (text.match(/^-+$/)) {
+        return parseTest;
       }
-      if (outputOrExpected) {
-        ctx.currentAssertion[outputOrExpected] = type + ' ' + content;
+      if (startsWith(text, TEST_TOKEN)) {
+        finishCurrentTest(ctx);
+        ctx.currentTest = { test: text.substring(TEST_TOKEN.length), assertions: [] };
+        return parseAssertion;
+      }
+      return parseModule(rule, ctx);
+    }
+    throw parseError('Unexpected rule type "' + rule.type + '"', 'test', rule.position);
+  };
+
+
+  var parseAssertion = function (rule, ctx) {
+    if (rule.type === 'comment') {
+      var text = rule.comment.trimLeft();
+      if (!text) { return parseAssertion; }
+      if (startsWith(text, PASS_TOKEN)) {
+        finishCurrentAssertion(ctx);
+        ctx.currentAssertion = {
+          description: text.substring(PASS_TOKEN.length).trim() || '<no description>',
+          passed: true
+        };
+        return parseAssertion;
+      } else if (startsWith(text, FAIL_TOKEN)) {
+        finishCurrentAssertion(ctx);
+        var endAssertionType = text.indexOf(END_FAIL_TOKEN);
+        ctx.currentAssertion = {
+          description: text.substring(endAssertionType + 2).trim(),
+          passed: false,
+          assertionType: text.substring(FAIL_TOKEN.length, endAssertionType).trim(),
+        };
         return parseFailureDetail;
+      } else if (startsWith(text, ASSERT_TOKEN)) {
+        finishCurrentAssertion(ctx);
+        ctx.currentAssertion = {
+          description: text.substring(ASSERT_TOKEN.length).trim(),
+          assertionType: 'equal'
+        };
+        return parseAssertionOutputStart;
       }
+      return parseTest(rule, ctx);
     }
-    return parseAssertion(rule, ctx);
+    throw parseError('Unexpected rule type "' + rule.type + '"', 'assertion', rule.position);
   }
-  throw parseError('Unexpected rule type "' + rule.type + '"', 'output/expected', rule.position);
-};
 
 
-var parseAssertionOutputStart = function (rule, ctx) {
-  if (rule.type === 'comment') {
-    var text = rule.comment.trim();
-    if (!text) { return parseAssertionOutputStart; }
-    if (text === OUTPUT_START_TOKEN) {
-      ctx.currentOutputRules = [];
-      return parseAssertionOutput;
+  var parseFailureDetail = function (rule, ctx) {
+    if (rule.type === 'comment') {
+      var text = rule.comment.trim();
+      if (startsWith(text, FAILURE_DETAIL_TOKEN)) {
+        var startType = text.indexOf(FAILURE_TYPE_START_TOKEN);
+        var endType = text.indexOf(FAILURE_TYPE_END_TOKEN);
+        var type = text.substring(startType, endType + 1);
+        var content = text.substring(endType + 3);
+        var outputOrExpected;
+        if (text.substring(FAILURE_DETAIL_TOKEN.length, startType) === OUTPUT_TOKEN) {
+          outputOrExpected = 'output';
+        } else if (text.substring(FAILURE_DETAIL_TOKEN.length, startType) === EXPECTED_TOKEN) {
+          outputOrExpected = 'expected';
+        }
+        if (outputOrExpected) {
+          ctx.currentAssertion[outputOrExpected] = type + ' ' + content;
+          return parseFailureDetail;
+        }
+      }
+      return parseAssertion(rule, ctx);
     }
-    throw parseError('Unexpected comment "' + text + '"', 'OUTPUT', rule.position);
-  }
-  throw parseError('Unexpected rule type "' + rule.type + '"', 'OUTPUT', rule.position);
-};
+    throw parseError('Unexpected rule type "' + rule.type + '"', 'output/expected', rule.position);
+  };
 
 
-var parseAssertionOutput = function (rule, ctx) {
-  if (rule.type === 'comment') {
-    if (rule.comment.trim() === OUTPUT_END_TOKEN) {
-      ctx.currentAssertion.output = css.stringify(
-        { stylesheet: { rules: ctx.currentOutputRules }});
-      delete ctx.currentOutputRules;
-      return parseAssertionExpectedStart;
+  var parseAssertionOutputStart = function (rule, ctx) {
+    if (rule.type === 'comment') {
+      var text = rule.comment.trim();
+      if (!text) { return parseAssertionOutputStart; }
+      if (text === OUTPUT_START_TOKEN) {
+        ctx.currentOutputRules = [];
+        return parseAssertionOutput;
+      }
+      throw parseError('Unexpected comment "' + text + '"', 'OUTPUT', rule.position);
     }
-  }
-  ctx.currentOutputRules.push(rule);
-  return parseAssertionOutput;
-};
+    throw parseError('Unexpected rule type "' + rule.type + '"', 'OUTPUT', rule.position);
+  };
 
 
-var parseAssertionExpectedStart = function (rule, ctx) {
-  if (rule.type === 'comment') {
-    var text = rule.comment.trim();
-    if (!text) { return parseAssertionExpectedStart; }
-    if (text === EXPECTED_START_TOKEN) {
-      ctx.currentExpectedRules = [];
-      return parseAssertionExpected;
+  var parseAssertionOutput = function (rule, ctx) {
+    if (rule.type === 'comment') {
+      if (rule.comment.trim() === OUTPUT_END_TOKEN) {
+        ctx.currentAssertion.output = css.stringify(
+          { stylesheet: { rules: ctx.currentOutputRules }});
+        delete ctx.currentOutputRules;
+        return parseAssertionExpectedStart;
+      }
     }
-    throw parseError('Unexpected comment "' + text + '"', 'EXPECTED', rule.position);
-  }
-  throw parseError('Unexpected rule type "' + rule.type + '"', 'EXPECTED', rule.position);
-};
-
-
-var parseAssertionExpected = function (rule, ctx) {
-  if (rule.type === 'comment') {
-    if (rule.comment.trim() === EXPECTED_END_TOKEN) {
-      ctx.currentAssertion.expected = css.stringify(
-        { stylesheet: { rules: ctx.currentExpectedRules }});
-      delete ctx.currentExpectedRules;
-      ctx.currentAssertion.passed = (
-        ctx.currentAssertion.output === ctx.currentAssertion.expected);
-      return parseEndAssertion;
+    ctx.currentOutputRules.push(rule);
+    return parseAssertionOutput;
+  };
+
+
+  var parseAssertionExpectedStart = function (rule, ctx) {
+    if (rule.type === 'comment') {
+      var text = rule.comment.trim();
+      if (!text) { return parseAssertionExpectedStart; }
+      if (text === EXPECTED_START_TOKEN) {
+        ctx.currentExpectedRules = [];
+        return parseAssertionExpected;
+      }
+      throw parseError('Unexpected comment "' + text + '"', 'EXPECTED', rule.position);
     }
-  }
-  ctx.currentExpectedRules.push(rule);
-  return parseAssertionExpected;
-};
+    throw parseError('Unexpected rule type "' + rule.type + '"', 'EXPECTED', rule.position);
+  };
+
+
+  var parseAssertionExpected = function (rule, ctx) {
+    if (rule.type === 'comment') {
+      if (rule.comment.trim() === EXPECTED_END_TOKEN) {
+        ctx.currentAssertion.expected = css.stringify(
+          { stylesheet: { rules: ctx.currentExpectedRules }});
+        delete ctx.currentExpectedRules;
+        ctx.currentAssertion.passed = (
+          ctx.currentAssertion.output === ctx.currentAssertion.expected);
+        return parseEndAssertion;
+      }
+    }
+    ctx.currentExpectedRules.push(rule);
+    return parseAssertionExpected;
+  };
+
+
+  var parseEndAssertion = function (rule, ctx) {
+    if (rule.type === 'comment') {
+      var text = rule.comment.trim();
+      if (!text) { return parseEndAssertion; }
+      if (text === ASSERT_END_TOKEN) {
+        finishCurrentAssertion(ctx);
+        return parseAssertion;
+      }
+      throw parseError('Unexpected comment "' + text + '"', 'END_ASSERT', rule.position);
+    }
+    throw parseError('Unexpected rule type "' + rule.type + '"', 'END_ASSERT', rule.position);
+  };
 
 
-var parseEndAssertion = function (rule, ctx) {
-  if (rule.type === 'comment') {
-    var text = rule.comment.trim();
-    if (!text) { return parseEndAssertion; }
-    if (text === ASSERT_END_TOKEN) {
-      finishCurrentAssertion(ctx);
-      return parseAssertion;
-    }
-    throw parseError('Unexpected comment "' + text + '"', 'END_ASSERT', rule.position);
-  }
-  throw parseError('Unexpected rule type "' + rule.type + '"', 'END_ASSERT', rule.position);
+  return parseCss();
 };
 
 
+
 var finishCurrentModule = function (ctx) {
   finishCurrentTest(ctx);
   if (ctx.currentModule) {