pombredanne/true

Sass unit tests

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 code; debug, perfect, etc. (often using True): True your sweet plugin before you deploy.

At this point True can only test values (e.g. function returns), not property/value output (e.g. mixin output).

Install

in command line:

# ruby gem
gem install true

# bower package
bower install true

Command Line

true-cli [options] PATH

Options:

• -s silent
• -c config file
• -d debug config file settings

Config file (optional):

options:
  color: true #enables colored output

# require ruby sass extension libraries
require:
  - "compass"
  - "serialy_sassy"

default location: test/true.yml

Usage

@import "true";

@include test-module('Utilities') {

  @include test('Map Add [function]') {
    $base: (one: 1, two: 1, three: 1);
    $add: (one: 1, two: 2, three: -1);

    $test: map-add($base, $add);
    $expect: (one: 2, two: 3, three: 0);
    @include assert-equal($test, $expect,
      'Returns the sum of two numeric maps');
  }

  @include test('Is Equal [function]') {
    $test: is-equal(1, 1rem);
    @include assert-equal($test, false,
      'Returns false for equal numbers with different units.');

    $test: is-equal(1, 1);
    @include assert-equal($test, true,
      'Returns true for numbers that are truely equal.');
  }
}

@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.