true 0.1.1 → 0.1.2

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 True Changelog
 ==============
 
+0.1.2 (6/7/13)
+--------------
+- Use nesting for modules with `test-module()`
+- Added failure message argument to all assertions.
+
+0.1.1 (6/6/13)
+--------------
+- Fix bug in `lib/true.rb` compass plugin registration.
+
 0.1.0 (6/6/13)
 --------------
 - `assert-true()`, `assert-false()`, `assert-equal()`, and `assert-unequal()`.

data/README.md

@@ -2,3 +2,46 @@ True
 ====
 
 A testing framework for compass/sass libraries.
+
+Install
+-------
+
+in command line:
+
+`gem install true`
+
+in config.rb:
+
+`require 'true'`
+
+Usage
+-----
+
+in your scss:
+
+```scss
+@import "true";
+
+// 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 {
+    $test-1: 3*5;
+    $test-2: if(something, true, false);
+
+    // Assert something, with a message to post if the assertion fails.
+    @include assert-equal($test-1, 15,
+      'Simple multiplication failed.');
+
+    // You can assert-equal, assert-unequal, assert-true, or assert-false.
+    @include assert-true($test-2,
+      'Something returned false.');
+  }
+
+}
+```
+
+**true** will report test results
+both in the command line
+and in the output css file.

data/sass/true/_assert.scss

@@ -2,31 +2,35 @@
 // ======
 
 @mixin assert-true(
-  $test
+  $assert,
+  $fail-message: '#{$assert} is not true.'
 ) {
-  @if $test { @include pass; }
-  @else { @include fail('#{$test} is not true.'); }
+  @if $assert { @include pass; }
+  @else { @include fail($fail-message); }
 }
 
 @mixin assert-false(
-  $test
+  $assert,
+  $fail-message: '#{$assert} is not false.'
 ) {
-  @if not $test { @include pass; }
-  @else { @include fail('#{$test} is not false.'); }
+  @if not $assert { @include pass; }
+  @else { @include fail($fail-message); }
 }
 
 @mixin assert-equal(
-  $test,
-  $expected
+  $assert,
+  $expected,
+  $fail-message: '#{$assert} != #{$expected}'
 ) {
-  @if $test == $expected { @include pass; }
-  @else { @include fail('#{$test} != #{$expected}'); }
+  @if $assert == $expected { @include pass; }
+  @else { @include fail($fail-message); }
 }
 
 @mixin assert-unequal(
-  $test,
-  $expected
+  $assert,
+  $expected,
+  $fail-message: '#{$assert} == #{$expected}'
 ) {
-  @if $test != $expected { @include pass; }
-  @else { @include fail('#{$test} == #{$expected}'); }
+  @if $assert != $expected { @include pass; }
+  @else { @include fail($fail-message); }
 }

data/sass/true/_modules.scss

@@ -1,20 +1,14 @@
 // Test Modules
 // ============
 
-$test-results: null;
-$test-module-name: null;
+$test-output: terminal css !default;
 
-// Establish a new test module
-@mixin start-test-module(
-  $name
-) {
-  $test-results: compact();
-  $test-module-name: $name;
-}
+$module-name: null;
+$test-results: null;
 
 // Collate test results
 @function collate-results(
-  $results: $test-results
+  $results
 ) {
   $total: length($results);
   $pass: 0;
@@ -28,25 +22,26 @@ $test-module-name: null;
   @return $total $pass $fail;
 }
 
-// Report the results of the module
-@mixin report-test-results(
-  $name: $test-module-name,
-  $results: $test-results
+// Establish a new test module
+@mixin test-module(
+  $name,
+  $output: $test-output
 ) {
-  $results: collate-results($results);
+  $module-name: $name;
+  $test-results: compact();
+
+  @content;
+
+  $results: collate-results($test-results);
   $total: nth($results, 1);
   $pass: nth($results, 2);
   $fail: nth($results, 3);
 
-  @if $name {
-    $result-message: '#{$name}: Passed #{$pass} of #{$total} (#{$fail} tests failed)';
-    /* #{$result-message} #{if($fail > 0, '************', null)}*/
-    @debug $result-message;
-  } @else {
-    @warn 'Remember to start your test module.';
-  }
+  $result-message: '#{$name}: Passed #{$pass} of #{$total} (#{$fail} tests failed)';
+
+  @if index($output, css) { /* #{$result-message} */ }
+  @if index($output, terminal) { @debug $result-message; }
 
-  // End module
+  $module-name: null;
   $test-results: null;
-  $test-module-name: null;
 }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: "true"
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Eric Meyer