true 0.1.3 → 0.1.4

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 True Changelog
 ==============
 
+0.1.4 (6/9/13)
+--------------
+- Null result is considered a failure.
+- Allow output to be turned off for certain modules/tests/assertions.
+
 0.1.3 (6/7/13)
 --------------
 - Nest assertions within `test() {}` named tests.

data/README.md

@@ -3,10 +3,9 @@ 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.
+At this point
+True can only test values,
+not property/value output.
 
 Install
 -------

data/sass/true/_modules.scss

@@ -5,34 +5,39 @@ $test-module-results  : null;
 
 // Establish a new test module
 @mixin test-module(
-  $name
+  $name,
+  $output: true
 ) {
   // Setup
   $test-result-context: module;
   $test-module-results: compact();
 
-  @include result-message('
+  @if $output {
+    @include result-message('
 
 ### #{$name} ------', css);
+  }
 
   // Content
   @content;
 
   // Results
-  $results: collate-results($test-module-results);
-  $total: nth($results, 1);
-  $pass: nth($results, 2);
-  $fail: nth($results, 3);
+  @if $output {
+    $results: collate-results($test-module-results);
+    $total: nth($results, 1);
+    $pass: nth($results, 2);
+    $fail: nth($results, 3);
 
-  $debug-message: '#{$name}: #{$total} Tests, #{$pass} Passed, #{$fail} failed';
-  @include result-message($debug-message, debug);
+    $debug-message: '#{$name}: #{$total} Tests, #{$pass} Passed, #{$fail} failed';
+    @include result-message($debug-message, debug);
 
-  $css-message: '
+    $css-message: '
     Summary:
     - #{$total} Tests
     - #{$pass} Passed
     - #{$fail} Failed';
-  @include result-message($css-message, css);
+    @include result-message($css-message, css);
+  }
 
   // Teardown
   $test-result-context: null;

data/sass/true/_results.scss

@@ -1,12 +1,17 @@
 // Results
 // =======
 
-$test-result-context: null;
+$test-result-context  : null;
 
-$pass-marker  : p;
-$fail-marker  : f;
+$pass-marker          : p;
+$fail-marker          : f;
+
+$test-pass-message    : '.'       !default;
+$test-fail-message    : 'F'       !default;
 
 // Collate test results
+// --------------------
+
 @function collate-results(
   $results
 ) {
@@ -22,7 +27,10 @@ $fail-marker  : f;
   @return $total $pass $fail;
 }
 
-// Record the results
+
+// Record test results
+// -------------------
+
 @mixin record-result(
   $result,
   $context: $test-result-context
@@ -43,24 +51,54 @@ $fail-marker  : f;
   }
 }
 
+
+// Report test results
+// -------------------
+
+@mixin report-test(
+  $name,
+  $results,
+  $context: module,
+  $output: true
+) {
+  $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 or $pass < 1 {
+    $fail-message: '- FAIL: ' + $message;
+    @include fail($fail-message, $context, $output: $output);
+    @if $output { @include result-message('FAIL: ' + $message, css); }
+  }
+  @else {
+    $pass-message: '- ' + $message;
+    @include pass($test-pass-message, $context, $output: $output);
+    @if $output { @include result-message($pass-message, css); }
+  }
+
+}
+
+
 // Pass / Fail
 // -----------
 
-$test-pass-message  : '.'             !default;
-$test-fail-message  : 'F'             !default;
-
 @mixin pass(
   $pass: $test-pass-message,
-  $context: $test-result-context
+  $context: $test-result-context,
+  $output: true
 ) {
   @include record-result(pass, $context);
-  @include result-message($pass, debug);
+  @if $output { @include result-message($pass, debug); }
 }
 
 @mixin fail(
   $fail: $test-fail-message,
-  $context: $test-result-context
+  $context: $test-result-context,
+  $output: true
 ) {
   @include record-result(fail, $context);
-  @include result-message($fail, warn);
+  @if $output { @include result-message($fail, warn); }
 }

data/sass/true/_tests.scss

@@ -5,7 +5,8 @@ $test-results: null;
 
 // Establish a new test
 @mixin test(
-  $name
+  $name,
+  $output: true
 ) {
   // Setup
   $test-results: compact();
@@ -19,33 +20,8 @@ $test-results: null;
   $test-result-context: $old-result-context;
 
   // Results
-  @include report-test($name, $test-results, $test-result-context);
+  @include report-test($name, $test-results, $test-result-context, $output);
 
   // 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: 29
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Eric Meyer
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-06-07 00:00:00 Z
+date: 2013-06-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: compass