true 0.1.5 → 0.2.0.rc.1

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA512: 
+  data.tar.gz: 6f95ec4f7cdf95ebafed598af43669a6ce28e8852b5bd2428daf4c05b7bc2f699475591768b26dd36d83e83d381aa74aa7a051354e62c98f81976e99d749df50
+  metadata.gz: d872cde92572c3e64cc67095de8a9acbe9371983a2c3ed3740777b4939ff9699c2d32a375b09a49792c4842b36aa0e3259595dbadd212b4651e9038feafefd9f
+SHA1: 
+  data.tar.gz: 217e7b41d4e4e3cb2e6a6c489b0f5c10c39683c0
+  metadata.gz: 05def0e5b64adad25f18216bce150543bc42dbf9

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 True Changelog
 ==============
 
+0.2.0 (unreleased)
+------------------
+- Simplified reporting in both terminal and CSS.
+- Remove `default-module-output`, `$default-test-output` and `$default-final-output`.
+  Replace them with `$true` settings map: `(output: css, summary: terminal css)`.
+  `output` handles test/module output, `summary` handles final output.
+  Assertions are always output to the terminal if they fail.
+- Update to use Sass map variables.
+- Add `report` function and `report` mixin, for reporting final results.
+
 0.1.5 (6/10/13)
 ---------------
 - Append actual results to custom failure messages.

data/README.md

@@ -7,16 +7,15 @@ True
   *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. A testing framework for Sass/Compass libraries:
-  *True your Sass before you deploy.*
+3. To test your Sass/Compass 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'd like that to change in the future,
-but it will require ruby code to achieve.
-In the meantime,
-you use True for logical unit tests,
+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.
 
@@ -34,31 +33,163 @@ in config.rb:
 Usage
 -----
 
-in your scss:
+Production example from
+[Susy Next](https://github.com/ericam/susy/blob/susy-next/test/scss/math/_columns.scss):
 
 ```scss
 @import "true";
 
-// Track and report results in a test module
-@include test-module('My Tests') {
+// Column Math Tests
+// =================
 
-  // Add tests
-  @include test('Feature A does The Things') {
-    $test-1: 3*5;
-    $test-2: if(something, true, false);
+@include test-module('Column Math') {
 
-    // Assert something, with a message to post if the assertion fails.
-    @include assert-equal($test-1, 15,
-      'Simple multiplication of `3*5` should return `15`.');
+  // Is Symmetrical
+  // --------------
 
-    // 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` should return `true` in the `if()` function.');
+  @include test('[function] is-symmetrical()') {
+    $sym: 12;
+    $asym: 1 2 4 1 2 1;
+    $baz: compact(4);
+
+    // 12 is a symmetrical grid.
+    $s: is-symmetrical($sym);
+    @include assert-true($s,
+      'Simple number should be symmetrical grid.');
+
+    // (1 2 4 1 2 1) is not a symmetrical grid.
+    $a: is-symmetrical($asym);
+    @include assert-false($a,
+      'List should be asymmetrical grid.');
+
+    // compact(4) is not a symmetrical grid (because it is a list).
+    $b: is-symmetrical($baz);
+    @include assert-false($b,
+      'Single-item list should be asymmetrical grid.');
+  }
+
+
+  // Column Count
+  // ------------
+
+  @include test('[function] column-count()') {
+    $sym: 12;
+    $asym: 1 2 4 1 2 1;
+
+    // A symmetrical grid is equal to its column count.
+    $s-count: column-count($sym);
+    @include assert-equal($s-count, $sym,
+      'Symmetrical grid-count should equal $columns setting.');
+
+    // An asymmetrical grid has a column-count equal to its length.
+    $a-count: column-count($asym);
+    $a-length: length($asym);
+    @include assert-equal($a-count, $a-length,
+      'Asymmetrical grid-count should equal $columns length.');
+  }
+
+
+  // Column Sum
+  // ----------
+
+  @include test('[function] symmetrical column-sum()') {
+    $cols   : 9;
+    $guts   : .5;
+    $sum    : column-sum($cols, $guts);
+    $outer  : column-sum($cols, $guts, outer);
+
+    @include assert-equal($sum, 13,
+      'Column-sum for "9 .5" should be "13".');
+
+    @include assert-equal($outer, 13.5,
+      'Outer column-sum for "9 .5" should be "13.5".');
+  }
+
+  @include test('[function] asymmetrical column-sum()') {
+    $sum    : column-sum(1 2 3 1 2, .25);
+    $outer  : column-sum(1 2 3 1 2, .25, outer);
+
+    @include assert-equal($sum, 10,
+      'Column-sum for "(1 2 3 1 2) .25" should be "10".');
+
+    @include assert-equal($outer, 10.25,
+      'Outer column-sum for "(1 2 3 1 2) .25" should be "10.25".');
+  }
+
+
+  // Get Columns
+  // -----------
+
+  @include test('[function] symmetrical get-columns()') {
+    $span: 3;
+    $context: 12;
+    $sub: get-columns($span, 4, $context);
+
+    @include assert-equal($sub, $span,
+      'Symmetrical get-columns subset should be equal to its span.');
+  }
+
+  @include test('[function] asymmetrical get-columns()') {
+    $span: 3;
+    $context: 1 2 3 1 2;
+    $sub: get-columns($span, 2, $context);
+
+    @include assert-equal($sub, 2 3 1,
+      'Get-columns subset for "3 of (1 2 3 1 2) at 2" should be "2 3 1".');
+  }
+
+
+  // Get Column Span Sum
+  // -------------------
+
+  @include test('[function] symmetrical get-column-span-sum()') {
+    $cols: 12;
+    $guts: 1/8;
+
+    $sum: get-column-span-sum(3, 2, $cols, $guts);
+    @include assert-equal($sum, 3.25,
+      'Inner span-sum for "3 of 12 1/8 at 2" should be "3.25"');
+
+    $sum: get-column-span-sum(3, last, $cols, $guts, outer);
+    @include assert-equal($sum, 3.375,
+      'Outer span-sum for "last 3 of 12 1/8" should be "3.375".');
+  }
+
+  @include test('[function] asymmetrical get-column-span-sum()') {
+    $cols: 1 2 3 2 1 2 3;
+    $guts: 1/4;
+
+    $sum: get-column-span-sum(3, 2, $cols, $guts);
+    @include assert-equal($sum, 7.5,
+      'Inner span-sum for "3 at 2 of (1 2 3 2 1 2 3)" should be "7.5".');
+
+    $sum: get-column-span-sum(3, last, $cols, $guts, outer);
+    @include assert-equal($sum, 6.75,
+      'Outer span-sum for "last 3 of (1 2 3 2 1 2 3)" should be "6.75".');
   }
 
 }
 ```
 
 **True** will report detailed results in the terminal,
-and a summary of results in the output css.
+and a summary of results in the output css.
+
+Here's the Susy "Column Math" CSS output:
+
+```css
+/*
+
+### Column Math ------ */
+/*  - [function] is-symmetrical() (3 Assertions, 3 Passed, 0 Failed) */
+/*  - [function] column-count() (2 Assertions, 2 Passed, 0 Failed) */
+/*  - [function] symmetrical column-sum() (2 Assertions, 2 Passed, 0 Failed) */
+/*  - [function] asymmetrical column-sum() (2 Assertions, 2 Passed, 0 Failed) */
+/*  - [function] symmetrical get-columns() (1 Assertions, 1 Passed, 0 Failed) */
+/*  - [function] asymmetrical get-columns() (1 Assertions, 1 Passed, 0 Failed) */
+/*  - [function] symmetrical get-column-span-sum() (2 Assertions, 2 Passed, 0 Failed) */
+/*  - [function] asymmetrical get-column-span-sum() (2 Assertions, 2 Passed, 0 Failed) */
+/*
+    8 Tests:
+    - 8 Passed
+    - 0 Failed */
+```

data/sass/_true.scss

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

data/sass/true/_assert.scss

@@ -3,42 +3,55 @@
 
 @mixin assert-true(
   $assert,
-  $fail-message: null
+  $fail-message: ''
 ) {
-  $default-message: ' (#{$assert} is not true)';
-  $fail-message: $fail-message + $default-message;
-  @if $assert { @include pass; }
-  @else { @include fail($fail-message); }
+  $test: map-get($test-results, name);
+  $fail-message: '#{$test}: ' + $fail-message + ' (#{$assert} is not true)';
+  $result: if($assert, pass, fail);
+  @include report-assert($result, $fail-message);
 }
 
 @mixin assert-false(
   $assert,
-  $fail-message: null
+  $fail-message: ''
 ) {
-  $default-message: ' (#{$assert} is not false)';
-  $fail-message: $fail-message + $default-message;
-  @if not $assert { @include pass; }
-  @else { @include fail($fail-message); }
+  $test: map-get($test-results, name);
+  $fail-message: '#{$test}: ' + $fail-message + ' (#{$assert} is not false)';
+  $result: if(not $assert, pass, fail);
+  @include report-assert($result, $fail-message);
 }
 
 @mixin assert-equal(
   $assert,
   $expected,
-  $fail-message: null
+  $fail-message: ''
 ) {
-  $default-message: ' (#{$assert} != #{$expected})';
-  $fail-message: $fail-message + $default-message;
-  @if $assert == $expected { @include pass; }
-  @else { @include fail($fail-message); }
+  $test: map-get($test-results, name);
+  $fail-message: '#{$test}: ' + $fail-message + ' (#{$assert} != #{$expected})';
+  $result: if($assert == $expected, pass, fail);
+  @include report-assert($result, $fail-message);
 }
 
 @mixin assert-unequal(
   $assert,
   $expected,
-  $fail-message: null
+  $fail-message: ''
 ) {
-  $default-message: ' (#{$assert} == #{$expected})';
-  $fail-message: $fail-message + $default-message;
-  @if $assert != $expected { @include pass; }
-  @else { @include fail($fail-message); }
+  $test: map-get($test-results, name);
+  $fail-message: '#{$test}: ' + $fail-message + ' (#{$assert} == #{$expected})';
+  $result: if($assert != $expected, pass, fail);
+  @include report-assert($result, $fail-message);
+}
+
+// Pass / Fail
+// -----------
+
+@mixin report-assert(
+  $result,
+  $fail-message: ''
+) {
+  @if $result == fail and $fail-message {
+    @warn $fail-message;
+  }
+  $test-results: map-add($test-results, (run: 1, $result: 1)) !global;
 }

data/sass/true/_modules.scss

@@ -1,45 +1,62 @@
-// Test Modules
-// ============
+// Test Module
+// ===========
 
-$test-module-results  : null;
+$module-results: null;
 
-// Establish a new test module
 @mixin test-module(
   $name,
-  $output: true
+  $output: map-get($true, output)
 ) {
-  // Setup
-  $test-result-context: module;
-  $test-module-results: compact();
+  $module-results: $blank-results !global;
+  @include setup-module($name, $output);
+  @content;
+  @include report-module($name, $module-results, $output);
+  $module-results: null !global;
+}
+
 
-  @if $output {
+// Module Setup (private)
+// ----------------------
+@mixin setup-module(
+  $name,
+  $output: map-get($true, output)
+) {
+  // Initial CSS Output
+  @if index($output, css) {
     @include result-message('
 
 ### #{$name} ------', css);
   }
+}
 
-  // Content
-  @content;
 
-  // Results
-  @if $output {
-    $results: collate-results($test-module-results);
-    $total: nth($results, 1);
-    $pass: nth($results, 2);
-    $fail: nth($results, 3);
+// Module Results (private)
+// ------------------------
+@mixin report-module(
+  $name,
+  $module-results,
+  $output: map-get($true, output)
+) {
 
-    $debug-message: '#{$name}: #{$total} Tests, #{$pass} Passed, #{$fail} failed';
+  // 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: '
-    Summary:
-    - #{$total} Tests
+    #{$run} Tests:
     - #{$pass} Passed
     - #{$fail} Failed';
     @include result-message($css-message, css);
   }
 
-  // Teardown
-  $test-result-context: null;
-  $test-module-results: null;
+  // Add to Total
+  $true-results: map-add($true-results, $module-results) !global;
 }

data/sass/true/_results.scss

@@ -1,104 +1,24 @@
 // Results
 // =======
 
-$test-result-context  : null;
-
-$pass-marker          : p;
-$fail-marker          : f;
-
-$test-pass-message    : '.'       !default;
-$test-fail-message    : 'F'       !default;
-
-// 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 test results
-// -------------------
-
-@mixin record-result(
-  $result,
-  $context: $test-result-context
+@function report(
+  $results: $true-results,
+  $items: 'Tests'
 ) {
-  $marker: null;
+  $run: map-get($results, run);
+  $pass: map-get($results, pass);
+  $fail: map-get($results, fail);
 
-  @if $result == 'pass' {
-    $marker: $pass-marker;
-  } @else if $result == 'fail' {
-    $marker: $fail-marker;
-  }
+  $message: '#{$run} #{$items}, #{$pass} Passed, #{$fail} Failed';
 
-  // record results
-  @if $context == 'test' {
-    $test-results: append($test-results, $marker);
-  } @else if $context == 'module' {
-    $test-module-results: append($test-module-results, $marker);
-  }
+  @return $message;
 }
 
-
-// Report test results
-// -------------------
-
-@mixin report-test(
-  $name,
-  $results,
-  $context: module,
-  $output: true
+@mixin report(
+  $output: map-get($true, summary)
 ) {
-  $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); }
+  $message: report($true-results);
+  @if index($output, terminal) {
+    @include result-message('SUMMARY: ' + $message, debug);
   }
-  @else {
-    $pass-message: '- ' + $message;
-    @include pass($test-pass-message, $context, $output: $output);
-    @if $output { @include result-message($pass-message, css); }
-  }
-
-}
-
-
-// Pass / Fail
-// -----------
-
-@mixin pass(
-  $pass: $test-pass-message,
-  $context: $test-result-context,
-  $output: true
-) {
-  @include record-result(pass, $context);
-  @if $output { @include result-message($pass, debug); }
-}
-
-@mixin fail(
-  $fail: $test-fail-message,
-  $context: $test-result-context,
-  $output: true
-) {
-  @include record-result(fail, $context);
-  @if $output { @include result-message($fail, warn); }
 }

data/sass/true/_settings.scss

@@ -0,0 +1,18 @@
+// True Settings
+// =============
+
+$true: (
+  output: css,
+  summary: terminal css
+) !default;
+
+
+// Results (private)
+// -----------------
+$blank-results: (
+  run: 0,
+  pass: 0,
+  fail: 0,
+);
+
+$true-results: $blank-results;

data/sass/true/_tests.scss

@@ -6,22 +6,59 @@ $test-results: null;
 // Establish a new test
 @mixin test(
   $name,
-  $output: true
+  $output: map-get($true, output)
 ) {
-  // Setup
-  $test-results: compact();
+  $test-results: map-merge($blank-results, (name: $name)) !global;
+  @content;
+  @include report-test($name, $test-results, $output);
+  $test-results: null !global;
+}
 
-  // Content
-  $old-result-context: $test-result-context;
-  $test-result-context: test;
+// Report test results
+// -------------------
 
-  @content;
+@mixin report-test(
+  $name,
+  $results,
+  $output: map-get($true, output)
+) {
+  $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 test-result($result, $message, $output);
+}
+
+// Pass / Fail Tests
+// -----------------
+
+@mixin test-result(
+  $result,
+  $message: '',
+  $output: map-get($true, output)
+) {
+  $css: null;
+  $terminal: null;
+
+  @if $result == fail {
+    $message: if($message, $message, map-get($true, fail));
+    $css: '- FAIL: ' + if($message, $message, '');
+    $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, '');
+  }
 
-  $test-result-context: $old-result-context;
+  @if index($output, terminal) and $terminal {
+    @include result-message($terminal, debug);
+  }
 
-  // Results
-  @include report-test($name, $test-results, $test-result-context, $output);
+  @if index($output, css) and $css {
+    @include result-message($css, css);
+  }
 
-  // Teardown
-  $test-results: null;
+  $module-results: map-add($module-results, (run: 1, $result: 1)) !global;
 }

data/sass/true/_utilities.scss

@@ -0,0 +1,18 @@
+// Utilities
+// =========
+
+// Add map values together
+@function map-add(
+  $base,
+  $add
+) {
+  @each $key, $value in $add {
+    @if $value {
+      $base-value: map-get($base, $key);
+      $new-value: if($base-value, $base-value + $value, $value);
+      $base: map-merge($base, ($key: $new-value));
+    }
+  }
+
+  @return $base;
+}

metadata

@@ -1,13 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: "true"
 version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 5
-  version: 0.1.5
+  version: 0.2.0.rc.1
 platform: ruby
 authors: 
 - Eric Meyer
@@ -15,41 +9,29 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-06-10 00:00:00 Z
+date: 2013-10-22 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: compass
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 43
-        segments: 
-        - 0
-        - 12
-        - 2
-        version: 0.12.2
+        version: 0.13.alpha.7
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: sass
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 3
-        - 2
-        - 0
-        version: 3.2.0
+        version: 3.3.0.rc.1
   type: :runtime
   version_requirements: *id002
-description: A framework to help you develop and manage compass/sass libraries with a test-driven approach.
+description: Unit tests for maintaining test-driven Sass/Compass extensions.
 email: 
 - eric@oddbird.net
 executables: []
@@ -68,13 +50,17 @@ files:
 - sass/true/_messages.scss
 - sass/true/_modules.scss
 - sass/true/_results.scss
+- sass/true/_settings.scss
 - sass/true/_tests.scss
+- sass/true/_utilities.scss
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-homepage: http://oddbird.net/
+homepage: http://eric.andmeyer.com/true
 licenses: []
 
+metadata: {}
+
 post_install_message: 
 rdoc_options: 
 - --line-numbers
@@ -86,30 +72,21 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 11
-      segments: 
-      - 1
-      - 2
       version: "1.2"
 requirements: []
 
 rubyforge_project: "true"
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 3
-summary: Testing framework for compass and sass libraries.
+summary: Testing framework for Sass libraries.
 test_files: []