true 1.0.1 → 2.0.0.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab5a6417b68be0dad0134effa015e923f4a655fd
-  data.tar.gz: a52b1f776572e2b2219ed32fc6406a16412fda33
+  metadata.gz: 37fe1fa3625dd64810916dbff4ebfb8b00b7dec6
+  data.tar.gz: ae02b6aa2ff13fb3102e494e2d3322832e1a6170
 SHA512:
-  metadata.gz: 12e482d1edbc75592f708d0e4a0b1ee914a158d62507042691184b9836dcceee9230fc46370090e712172aa5075aeae7ab0e77040b6ad34f037a226309b73485
-  data.tar.gz: dab87289bd9df35090f56d1e501603a4d8cbd4fbdbcde4319d5a3f91299e68ff6e26274d360e669e1a47388b786bb8e850751209d62fafb020c134fc48a6e8a8
+  metadata.gz: ffde38be2ebbe2c7d44b5e8615ae25520b065ccfd39f56c7baf8fc6c21279692c667194e2969e083f9b84a998f8d606968fb2d12c46d7050b7cf1b4b7e2d95df
+  data.tar.gz: 68fc5538a15aa885ad0bf1bcdb04dfea75badd82a85ab59e361c3c47d3f3d78e9b46ea96abf0ad183e79912ce88833ecfa44755ba7ec398043ff6b2f9263617c

data/CHANGELOG.md

@@ -1,6 +1,19 @@
 True Changelog
 ==============
 
+2.0 (unreleased)
+----------------
+- Improve internal logic, and namespace private functions behind `_true-*`.
+- Add `assert()`, `input`, and `expect` mixins for testing CSS output.
+- Support for LibSass
+- Simplify output options down to single `$true-terminal-output` setting.
+
+
+1.0.1 (10/18/14)
+----------------
+- LibSass 3.0 compatability.
+
+
 1.0.0 (10/3/14)
 ---------------
 - Add command-line interface: `true-cli <path-to-file>`

data/README.md

@@ -1,26 +1,20 @@
-[![Build Status](https://travis-ci.org/ericam/true.png?branch=master)](https://travis-ci.org/ericam/true)
-
-
 True
 ====
 
+[![Build Status](https://travis-ci.org/ericam/true.png?branch=master)](https://travis-ci.org/ericam/true)
+
 *Verb*
 
 1. To make true; shape, adjust, place, etc., exactly or accurately:
   *True the wheels of a bicycle after striking a pothole.*
 2. To make even, symmetrical, level, etc. (often followed by *up*):
   *True up the sides of a door.*
-3. To test your Sass/Compass code; debug, perfect, etc. (often using *True*):
+3. To test your Sass code; debug, perfect, etc. (often using *True*):
   *True your sweet plugin before you deploy.*
 
 At this point
-True can only test values,
-not property/value output.
-I'm working on output tests as well.
-For now,
-use True for logical unit tests,
-and use version-control for integration testing
-by comparing changes in output files.
+True can only test values (e.g. function returns),
+not property/value output (e.g. mixin output).
 
 
 Install
@@ -28,17 +22,21 @@ Install
 
 in command line:
 
-`gem install true`
-
-in config.rb:
+```bash
+# ruby gem
+gem install true
 
-`require 'true'`
+# bower package
+bower install true
+```
 
 
 Command Line
------
+------------
 
-`true-cli [options] PATH`
+```bash
+true-cli [options] PATH
+```
 
 Options:
 * `-s` slient
@@ -47,7 +45,7 @@ Options:
 
 Config file (optional):
 
-``` yaml
+```yaml
 options:
   color: true #enables colored output
 
@@ -78,7 +76,7 @@ Usage
       'Returns the sum of two numeric maps');
   }
 
-  @include test('Strict Equal [function]') {
+  @include test('Is Equal [function]') {
     $test: is-equal(1, 1rem);
     @include assert-equal($test, false,
       'Returns false for equal numbers with different units.');
@@ -88,19 +86,22 @@ Usage
       'Returns true for numbers that are truely equal.');
   }
 }
-```
 
-**True** will report to both the terminal and an output css file by default.
-
-Here's a sample of the CSS output:
-
-```css
-/* ### Utilities ---------- */
-/* - Map Add [function] (1 Assertions, 1 Passed, 0 Failed) */
-/* - Strict Equal [function] (2 Assertions, 2 Passed, 0 Failed) */
-/*
-*/
-/* 2 Tests: */
-/*  - 2 Passed */
-/*  - 0 Failed */
+@include report;
 ```
+
+Settings
+--------
+
+There is only one setting.
+`$true-terminal-output` controls what output (if any)
+is shown in the terminal.
+The default setting is `true`,
+which will show warnings in the terminal
+when an assertion fails.
+You can set it to `false` to turn off all terminal output,
+or `details` to show more `@debug` info on failures,
+and a final summary of the results.
+
+* LibSass doesn't support `@debug`.
+* The Ruby CLI requires the final summary output.

data/VERSION

@@ -1 +1 @@
-1.0.0
+2.0.0.alpha.1

data/sass/true/_assert.scss

@@ -1,73 +1,157 @@
 // Assert
 // ======
 
+
 @mixin assert-true(
   $assert,
-  $fail-message: ''
+  $description: ''
 ) {
-  $name: map-get($test-results, name);
-  $debug-message: '#{inspect($assert)} is not true';
+  @include _true-assert-start($description);
   $result: if($assert, pass, fail);
-  @include report-assert($name, $result, $fail-message, $debug-message...);
+
+  .assert-true {
+    -result: to-upper-case($result);
+    -description: $description;
+
+    @if $result == fail {
+      @include _true-fail-details(true, $assert);
+    }
+  }
+
+  @include _true-assert-stop($result);
 }
 
+
 @mixin assert-false(
   $assert,
-  $fail-message: ''
+  $description: ''
 ) {
-  $name: map-get($test-results, name);
-  $debug-message: '#{inspect($assert)} is not false';
-  $result: if(not $assert, pass, fail);
-  @include report-assert($name, $result, $fail-message, $debug-message...);
+  @include _true-assert-start($description);
+  $result: if($assert, fail, pass);
+
+  .assert-false {
+    -result: to-upper-case($result);
+    -description: $description;
+
+    @if $result == fail {
+      @include _true-fail-details(false, $assert);
+    }
+  }
+
+  @include _true-assert-stop($result);
 }
 
+
 @mixin assert-equal(
   $assert,
   $expected,
-  $fail-message: ''
+  $description: ''
 ) {
-  $name: map-get($test-results, name);
-  $debug-message: 'Expected: #{inspect($expected)}',
-                  'Result: #{inspect($assert)}';
-  $result: if(is-equal($assert, $expected), pass, fail);
-  @include report-assert($name, $result, $fail-message, $debug-message...);
+  @include _true-assert-start($description);
+  $result: if(_true-is-equal($assert, $expected), pass, fail);
+
+  .assert-equal {
+    -result: to-upper-case($result);
+    -description: $description;
+
+    @if $result == fail {
+      @include _true-fail-details($expected, $assert);
+    }
+  }
+
+  @include _true-assert-stop($result);
 }
 
+
 @mixin assert-unequal(
   $assert,
   $expected,
-  $fail-message: ''
+  $description: ''
+) {
+  @include _true-assert-start($description);
+  $result: if(_true-is-equal($assert, $expected), fail, pass);
+
+  .assert-unequal {
+    -result: to-upper-case($result);
+    -description: $description;
+
+    @if $result == fail {
+      @include _true-fail-details($expected, $assert);
+    }
+  }
+
+  @include _true-assert-stop($result);
+}
+
+
+// CSS Output Tests
+// ----------------
+
+@mixin assert(
+  $description
 ) {
-  $name: map-get($test-results, name);
-  $debug-message: 'Expected: #{inspect($expected)}',
-                  'Result: #{inspect($assert)}';
-  $result: if(is-equal($assert, $expected), fail, pass);
-  @include report-assert($name, $result, $fail-message, $debug-message...);
+  @include _true-assert-start($description);
+
+  #{_true-selector(assert)} {
+    @content;
+  }
+
+  @include _true-assert-stop(output-to-css);
+}
+
+@mixin input {
+  .input {
+    @content;
+  }
+}
+
+@mixin expect {
+  .expect {
+    @content;
+  }
 }
 
-// Pass / Fail
-// -----------
 
-@mixin report-assert(
-  $name,
-  $result,
-  $fail-message: false,
-  $debug...
+// Assert Start
+// ------------
+
+@mixin _true-assert-start(
+  $name
 ) {
-  @if $result == fail {
-    @debug 'FAIL: #{$name}';
+  @include _true-context(assert, $name);
+}
 
-    @each $item in $debug {
-      @debug $item;
-    }
+@mixin _true-assert-stop(
+  $result
+) {
+  @include _true-update(test, $result);
+  @include _true-context(assert, null);
+}
 
-    @if $fail-message {
-      @warn $fail-message;
-    }
 
-    $test-details: $test-details + $-tnl + '  - error: '
-                   + '(#{$debug}) ' + $fail-message !global;
+// Details
+// -------
+
+@mixin _true-fail-details(
+  $expected,
+  $returned,
+  $terminal: $true-terminal-output
+) {
+  $expected-type: type-of($expected);
+  $returned-type: type-of($returned);
+
+  -expected--#{$expected-type}: _true-inspect($expected);
+  -returned--#{$returned-type}: _true-inspect($returned);
+
+  @if $terminal == details {
+    @debug '[FAIL] #{_true-context(test)} » #{_true-context(assert)}';
+    @debug 'Expected #{$expected-type} »';
+    @debug inspect($expected);
+    @debug 'Returned #{$returned-type} »';
+    @debug inspect($returned);
   }
 
-  $test-results: map-add($test-results, (run: 1, $result: 1)) !global;
+  @if $terminal {
+    @warn '#{_true-context(test)} » #{_true-context(assert)}';
+  }
 }

data/sass/true/_messages.scss

@@ -3,17 +3,36 @@
 
 $-tnl: "\a ";
 
-@mixin spacer-comment() {
+
+// Return a CSS selector for the current context
+@function _true-selector(
+  $scope
+) {
+  $selector: null;
+
+  @each $layer in $scope {
+    $this: '[data-#{$layer}="#{_true-context($layer)}"]';
+    $selector: if($selector, '#{$selector} #{$this}', $this);
+  }
+
+  @return $selector;
+}
+
+
+// Output a spacer comment
+@mixin _true-spacer() {
 /*
 */
 }
 
-@mixin result-message(
+
+// Output a message to CSS, Terminal, or Comments
+@mixin _true-message(
   $message,
-  $output
+  $output: comments
 ) {
-  $lines: str-split($message, $-tnl);
-  @if index($output, css) {
+  $lines: _true-str-split($message, $-tnl);
+  @if index($output, comments) {
     @each $line in $lines {
       /* #{$line} */
     }

data/sass/true/_modules.scss

@@ -1,60 +1,33 @@
 // Test Module
 // ===========
 
-$module-results: null;
 
 @mixin test-module(
-  $name,
-  $output: map-get($true, output)
+  $name
 ) {
-  $module-results: $blank-results !global;
-  @include setup-module($name, $output);
+  @include _true-module-start($name);
   @content;
-  @include report-module($name, $module-results, $output);
-  $module-results: null !global;
+  @include _true-module-stop;
 }
 
 
-// Module Setup (private)
+// Module Start (private)
 // ----------------------
-@mixin setup-module(
-  $name,
-  $output: map-get($true, output)
-) {
-  // Initial CSS Output
-  @if index($output, css) {
-    @include result-message('### #{$name} ----------', css);
-  }
-}
-
 
-// Module Results (private)
-// ------------------------
-@mixin report-module(
-  $name,
-  $module-results,
-  $output: map-get($true, output)
+@mixin _true-module-start(
+  $name
 ) {
+  @include _true-reset(module);
+  @include _true-context(module, $name);
+  @include _true-message('# #{$name} ----------', comments);
+}
 
-  // Terminal Results
-  @if index($output, terminal) {
-    $debug-message: '#{$name}: #{report($module-results, Tests)})';
-    @include result-message($debug-message, debug);
-  }
-
-  // CSS Results
-  @if index($output, css) {
-    $run: map-get($module-results, run);
-    $pass: map-get($module-results, pass);
-    $fail: map-get($module-results, fail);
-
-    $css-message: '#{$run} Tests:#{$-tnl} - #{$pass} Passed#{$-tnl} - #{$fail} Failed';
 
-    @include spacer-comment;
-    @include result-message($css-message, css);
-    @include spacer-comment;
-  }
+// Module Stop (private)
+// ---------------------
 
-  // Add to Total
-  $true-results: map-add($true-results, $module-results) !global;
+@mixin _true-module-stop {
+  @include _true-update(global, null);
+  @include _true-reset(module);
+  @include _true-context(module, null);
 }

data/sass/true/_results.scss

@@ -1,24 +1,150 @@
 // Results
 // =======
 
-@function report(
-  $results: $true-results,
-  $items: 'Tests'
+$_true-results-reset: (
+  run: 0,
+  pass: 0,
+  fail: 0,
+  output-to-css: 0,
+);
+
+$_true-results: (
+  global: $_true-results-reset,
+  module: $_true-results-reset,
+  test: $_true-results-reset,
+);
+
+
+// Reset
+// -----
+
+@mixin _true-reset(
+  $scope
+) {
+  @if $scope == global {
+    $_true-results: (
+      global: $_true-results-reset,
+      module: $_true-results-reset,
+      test: $_true-results-reset,
+    ) !global;
+  } @else if $scope == module {
+    $update: (
+      module: $_true-results-reset,
+      test: $_true-results-reset,
+    );
+    $_true-results: map-merge($_true-results, $update) !global;
+  } @else if $scope == test {
+    $update: (
+      test: $_true-results-reset
+    );
+    $_true-results: map-merge($_true-results, $update) !global;
+  } @else {
+    @warn "#{$scope} is not a valid scope for _true-reset().";
+  }
+}
+
+
+// Get Results
+// -----------
+
+@function _true-get-results(
+  $scope
 ) {
+  @return map-get($_true-results, $scope);
+}
+
+
+// Get Result
+// ----------
+
+@function _true-get-result(
+  $scope
+) {
+  $results: _true-get-results($scope);
+  $return: if(map-get($results, output-to-css) > 0, output-to-css, null);
+
+  @if map-get($results, fail) > 0 {
+    @return if($return, $return fail, fail);
+  } @else if map-get($results, pass) > 0 {
+    @return if($return, $return pass, pass);
+  } @else {
+    @return $return;
+  }
+}
+
+
+// Update
+// ------
+
+@mixin _true-update(
+  $scope,
+  $results
+) {
+  $current: _true-get-results($scope);
+  $update: (run: 1);
+
+  @if $scope == global {
+    $update: _true-get-results(module);
+  } @else {
+    @each $result in $results {
+      @if $result {
+        $update: map-merge($update, ($result: 1));
+      }
+    }
+  }
+
+  $scope: ($scope: _true-map-increment($current, $update));
+  $_true-results: map-merge($_true-results, $scope) !global;
+}
+
+
+// Report Message
+// --------------
+
+@function _true-report-message(
+  $scope: test,
+  $lines: single
+) {
+  $results: _true-get-results($scope);
   $run: map-get($results, run);
   $pass: map-get($results, pass);
   $fail: map-get($results, fail);
+  $output-to-css: map-get($results, output-to-css);
 
-  $message: '#{$run} #{$items}, #{$pass} Passed, #{$fail} Failed';
+  $items: null;
+  $message: null;
+
+  @if $scope == global or $scope == module {
+    $items: Tests;
+  } @else if $scope == test {
+    $items: Assertions;
+  }
+
+  @if $lines == single {
+    $message: '#{$run} #{$items}, #{$pass} Passed, #{$fail} Failed';
+    $message: if($output-to-css > 0, $message + ', #{$output-to-css} Output to CSS', $message);
+  } @else {
+    $message: '#{$run $items}:#{$-tnl} - #{$pass} Passed#{$-tnl} - #{$fail} Failed';
+    $message: if($output-to-css > 0, $message + '#{$-tnl} - #{$output-to-css} Output to CSS', $message);
+  }
 
   @return $message;
 }
 
+
+// Report
+// ------
+
 @mixin report(
-  $output: map-get($true, summary)
+  $terminal: $true-terminal-output
 ) {
-  $message: report($true-results);
-  @if index($output, terminal) {
-    @include result-message('SUMMARY: ' + $message, debug);
+  $message: _true-report-message(global, multiple);
+  @include _true-message('# SUMMARY ----------', comments);
+  @include _true-message($message, comments);
+  @include _true-message('--------------------', comments);
+
+  @if $terminal == details {
+    $message: _true-report-message(global, single);
+    @include _true-message($message, debug);
   }
 }

data/sass/true/_settings.scss

@@ -1,18 +1,27 @@
 // True Settings
 // =============
 
-$true: (
-  output: css,
-  summary: terminal css
-) !default;
+$true-terminal-output: true !default;
 
 
-// Results (private)
+// Context (private)
 // -----------------
-$blank-results: (
-  run: 0,
-  pass: 0,
-  fail: 0,
+
+$_true-context: (
+  module: null,
+  test: null,
+  assert: null,
 );
 
-$true-results: $blank-results;
+@mixin _true-context(
+  $scope,
+  $name
+) {
+  $_true-context: map-merge($_true-context, ($scope: $name)) !global;
+}
+
+@function _true-context(
+  $scope
+) {
+  @return map-get($_true-context, $scope);
+}

data/sass/true/_tests.scss

@@ -1,69 +1,36 @@
 // Tests
 // =====
 
-$test-results: null;
-$test-details: '';
 
-// Establish a new test
 @mixin test(
-  $name,
-  $output: map-get($true, output)
+  $name
 ) {
-  $test-results: map-merge($blank-results, (name: $name)) !global;
-  $test-details: '' !global;
-  @content;
-  @include report-test($name, $test-results, $output, $test-details);
-  $test-results: null !global;
-  $test-details: '' !global;
-}
-
-// Report test results
-// -------------------
-
-@mixin report-test(
-  $name,
-  $results,
-  $output: map-get($true, output),
-  $details: ''
-) {
-  $pass: map-get($results, pass);
-  $fail: map-get($results, fail);
-  $result: if($fail > 0 or $pass < 1, fail, pass);
-
-  $message: '#{$name} (#{report($results, Assertions)})';
+  @include _true-test-start($name);
 
-  @include test-result($result, $message, $output, $details);
+  #{_true-selector(module test)} {
+    @content;
+    @include _true-test-stop;
+  }
 }
 
-// Pass / Fail Tests
-// -----------------
 
-@mixin test-result(
-  $result,
-  $message: '',
-  $output: map-get($true, output),
-  $details: ''
-) {
-  $css: null;
-  $terminal: null;
+// Module Start (private)
+// ----------------------
 
-  @if $result == fail {
-    $message: if($message, $message, map-get($true, fail));
-    $css: '- FAIL: ' + if($message, $message, '') + $details;
-    $terminal: 'FAIL: ' + if($message, $message, '');
-  } @else if $result == pass {
-    $message: if($message, $message, map-get($true, pass));
-    $css: '- ' + if($message, $message, '');
-    $terminal: if($message, $message, '');
-  }
+@mixin _true-test-start(
+  $name
+) {
+  @include _true-reset(test);
+  @include _true-context(test, $name);
+  @include _true-message($name, comments);
+}
 
-  @if index($output, terminal) and $terminal {
-    @include result-message($terminal, debug);
-  }
 
-  @if index($output, css) and $css {
-    @include result-message($css, css);
-  }
+// Module Stop (private)
+// ---------------------
 
-  $module-results: map-add($module-results, (run: 1, $result: 1)) !global;
+@mixin _true-test-stop {
+  @include _true-update(module, _true-get-result(test));
+  @include _true-reset(test);
+  @include _true-context(test, null);
 }

data/sass/true/_utilities.scss

@@ -2,11 +2,13 @@
 // =========
 
 // Add map values together
-@function map-add(
+@function _true-map-increment(
   $base,
   $add
 ) {
-  @each $key, $value in $add {
+  @each $key in map-keys($add) {
+    $value: map-get($add, $key);
+
     @if $value {
       $base-value: map-get($base, $key);
       $new-value: if($base-value, $base-value + $value, $value);
@@ -18,7 +20,10 @@
 }
 
 // Split a string
-@function str-split($string, $substring) {
+@function _true-str-split(
+  $string,
+  $substring
+) {
   $strings: ();
   $found-at: str-index($string, $substring);
   @while $found-at {
@@ -30,11 +35,39 @@
   @return $strings;
 }
 
+
 // Check for strict equality
-@function is-equal($one, $two) {
+@function _true-is-equal($one, $two) {
   @if type-of($one) == number and type-of($two) == number {
     @return $one == $two and unit($one) == unit($two);
   } @else {
     @return $one == $two;
   }
 }
+
+
+// Inspect
+@function _true-inspect(
+  $value
+) {
+  @if function-exists(inspect) {
+    @if type-of($value) == map {
+      @return '#{inspect($value)}';
+    } @else {
+      @return inspect($value);
+    }
+  } @else if $value == null {
+    @return 'null';
+  } @else if type-of($value) == map {
+    $map: '(';
+    $keys: map-keys($value);
+    @each $key in $keys {
+      $val: map-get($value, $key);
+      $last: if(index($keys, $key) == length($keys), true, false);
+      $map: '#{$map}#{$key}: #{$val}#{if($last, ")", ", ")}';
+    }
+    @return $map;
+  } @else {
+    @return $value;
+  }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: 'true'
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0.alpha.1
 platform: ruby
 authors:
 - Eric Suzanne