true 0.1.2 → 0.1.3

data/CHANGELOG.md

@@ -1,9 +1,14 @@
 True Changelog
 ==============
 
+0.1.3 (6/7/13)
+--------------
+- Nest assertions within `test() {}` named tests.
+- Cleaner css output.
+
 0.1.2 (6/7/13)
 --------------
-- Use nesting for modules with `test-module()`
+- Use nesting for modules with `test-module() {}`
 - Added failure message argument to all assertions.
 
 0.1.1 (6/6/13)

data/README.md

@@ -3,6 +3,11 @@ True
 
 A testing framework for compass/sass libraries.
 
+At this point,
+True is better at testing functions than mixins -
+because it is easier to test a value
+than the actual property-value css output.
+
 Install
 -------
 
@@ -25,8 +30,8 @@ in your scss:
 // Track and report results in a test module
 @include test-module('My Tests') {
 
-  // silent classes can help you organize tests and scope variables.
-  %test__feature-1 {
+  // Add tests
+  @include test('Feature A does The Things') {
     $test-1: 3*5;
     $test-2: if(something, true, false);
 
@@ -35,6 +40,7 @@ in your scss:
       'Simple multiplication failed.');
 
     // You can assert-equal, assert-unequal, assert-true, or assert-false.
+    // A test can include as many assertions as you need.
     @include assert-true($test-2,
       'Something returned false.');
   }
@@ -42,6 +48,5 @@ in your scss:
 }
 ```
 
-**true** will report test results
-both in the command line
-and in the output css file.
+**True** will report detailed results in the terminal,
+and a summary of results in the output css.

data/sass/_true.scss

@@ -1,6 +1,8 @@
 // Susy partials
 // =============
 
-@import "true/modules";
 @import "true/messages";
+@import "true/results";
+@import "true/modules";
+@import "true/tests";
 @import "true/assert";

data/sass/true/_messages.scss

@@ -1,19 +1,15 @@
-// Pass / Fail Messages
-// ====================
+// Messages
+// ========
 
-$test-pass-message  : '.'   !default;
-$test-fail-message  : 'F'   !default;
-
-@mixin pass(
-  $pass: $test-pass-message
-) {
-  $test-results: append($test-results, 'p');
-  @debug $pass;
-}
-
-@mixin fail(
-  $fail: $test-fail-message
+@mixin result-message(
+  $message,
+  $output
 ) {
-  $test-results: append($test-results, 'f');
-  @warn $fail;
+  @if index($output, css) {
+    /*  #{$message} */
+  } @else if index($output, debug) or index($output, terminal) {
+    @debug $message;
+  } @else if index($output, warn) {
+    @warn $message;
+  }
 }

data/sass/true/_modules.scss

@@ -1,47 +1,40 @@
 // Test Modules
 // ============
 
-$test-output: terminal css !default;
-
-$module-name: null;
-$test-results: null;
-
-// Collate test results
-@function collate-results(
-  $results
-) {
-  $total: length($results);
-  $pass: 0;
-  $fail: 0;
-
-  @each $test in $results {
-    @if $test == 'p' { $pass: $pass + 1; }
-    @if $test == 'f' { $fail: $fail + 1; }
-  }
-
-  @return $total $pass $fail;
-}
+$test-module-results  : null;
 
 // Establish a new test module
 @mixin test-module(
-  $name,
-  $output: $test-output
+  $name
 ) {
-  $module-name: $name;
-  $test-results: compact();
+  // Setup
+  $test-result-context: module;
+  $test-module-results: compact();
+
+  @include result-message('
+
+### #{$name} ------', css);
 
+  // Content
   @content;
 
-  $results: collate-results($test-results);
+  // Results
+  $results: collate-results($test-module-results);
   $total: nth($results, 1);
   $pass: nth($results, 2);
   $fail: nth($results, 3);
 
-  $result-message: '#{$name}: Passed #{$pass} of #{$total} (#{$fail} tests failed)';
+  $debug-message: '#{$name}: #{$total} Tests, #{$pass} Passed, #{$fail} failed';
+  @include result-message($debug-message, debug);
 
-  @if index($output, css) { /* #{$result-message} */ }
-  @if index($output, terminal) { @debug $result-message; }
+  $css-message: '
+    Summary:
+    - #{$total} Tests
+    - #{$pass} Passed
+    - #{$fail} Failed';
+  @include result-message($css-message, css);
 
-  $module-name: null;
-  $test-results: null;
+  // Teardown
+  $test-result-context: null;
+  $test-module-results: null;
 }

data/sass/true/_results.scss

@@ -0,0 +1,66 @@
+// Results
+// =======
+
+$test-result-context: null;
+
+$pass-marker  : p;
+$fail-marker  : f;
+
+// Collate test results
+@function collate-results(
+  $results
+) {
+  $total: length($results);
+  $pass: 0;
+  $fail: 0;
+
+  @each $test in $results {
+    @if $test == $pass-marker { $pass: $pass + 1; }
+    @if $test == $fail-marker { $fail: $fail + 1; }
+  }
+
+  @return $total $pass $fail;
+}
+
+// Record the results
+@mixin record-result(
+  $result,
+  $context: $test-result-context
+) {
+  $marker: null;
+
+  @if $result == 'pass' {
+    $marker: $pass-marker;
+  } @else if $result == 'fail' {
+    $marker: $fail-marker;
+  }
+
+  // record results
+  @if $context == 'test' {
+    $test-results: append($test-results, $marker);
+  } @else if $context == 'module' {
+    $test-module-results: append($test-module-results, $marker);
+  }
+}
+
+// Pass / Fail
+// -----------
+
+$test-pass-message  : '.'             !default;
+$test-fail-message  : 'F'             !default;
+
+@mixin pass(
+  $pass: $test-pass-message,
+  $context: $test-result-context
+) {
+  @include record-result(pass, $context);
+  @include result-message($pass, debug);
+}
+
+@mixin fail(
+  $fail: $test-fail-message,
+  $context: $test-result-context
+) {
+  @include record-result(fail, $context);
+  @include result-message($fail, warn);
+}

data/sass/true/_tests.scss

@@ -0,0 +1,51 @@
+// Tests
+// =====
+
+$test-results: null;
+
+// Establish a new test
+@mixin test(
+  $name
+) {
+  // Setup
+  $test-results: compact();
+
+  // Content
+  $old-result-context: $test-result-context;
+  $test-result-context: test;
+
+  @content;
+
+  $test-result-context: $old-result-context;
+
+  // Results
+  @include report-test($name, $test-results, $test-result-context);
+
+  // Teardown
+  $test-results: null;
+}
+
+@mixin report-test(
+  $name,
+  $results,
+  $context
+) {
+  $results: collate-results($test-results);
+  $total: nth($results, 1);
+  $pass: nth($results, 2);
+  $fail: nth($results, 3);
+
+  $message: '#{$name} (#{$total} assertions, #{$pass} passed, #{$fail} failed)';
+
+  @if $fail > 0 {
+    $fail-message: '- FAIL: ' + $message;
+    @include fail($fail-message, module);
+    @include result-message('FAIL: ' + $message, css);
+  }
+  @else {
+    $pass-message: '- ' + $message;
+    @include pass($test-pass-message, module);
+    @include result-message($pass-message, css);
+  }
+
+}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: "true"
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: 
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Eric Meyer
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-06-06 00:00:00 Z
+date: 2013-06-07 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: compass
@@ -67,6 +67,8 @@ files:
 - sass/true/_assert.scss
 - sass/true/_messages.scss
 - sass/true/_modules.scss
+- sass/true/_results.scss
+- sass/true/_tests.scss
 - CHANGELOG.md
 - LICENSE.txt
 - README.md