true 0.2.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: edbabfb443c014cde7537ac4bb2b9d6d901424e3
-  data.tar.gz: a9455cced338c3eb213b247291ae8584bca02e08
+  metadata.gz: 4991a75b377b7447e85b46077701cd8886520605
+  data.tar.gz: 4e7afcea7dbd134caa728473f2b73a1e7ffd01e1
 SHA512:
-  metadata.gz: a56c48a52c8047dacd1cc35f2059c8aafffedbe4ffaefcc576b5fc49cd50b019612c7b3cafb95f43468b536950f8e8c92d20130f2967575d557b04ebe8cad159
-  data.tar.gz: 049944205f25a1ceff0c5c42d46c2a735e9471822d5da2bd1dc15351a312462ac677f36d6ffc6026dd73ffc0216f5ac8e42005e96268e42b99729fdb10b82c12
+  metadata.gz: 7ee7cc9c924ad1dfddeb231e7083b1299a4dc8f01cf53067a68fbf7f53521a0eb1282ed5b0f6826a2d8771883a2f89a0d8dfaf3016c3de1918e58930aa7a5314
+  data.tar.gz: 786b63b92a43ec1ad116fc2aaf901537cb9a7e7eb75951942e74da9612ef54b80d6b83b62eaa32f385acaaa69fa706ee41f9c670e87094e279bacdb9773f5da4

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 True Changelog
 ==============
 
+1.0.0 (10/3/14)
+---------------
+- Add command-line interface: `true-cli <path-to-file>`
+- Use `-s` flag for silent output
+- Check for unit differences between numbers.
+- Add assertion-failure details to css output.
+
+
 0.2.0 (7/15/14)
 ---------------
 - Simplified reporting in both terminal and CSS.

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013, Eric Meyer
+Copyright (c) 2014, Eric Suzanne
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/README.md

@@ -1,5 +1,6 @@
 [![Build Status](https://travis-ci.org/ericam/true.png?branch=master)](https://travis-ci.org/ericam/true)
 
+
 True
 ====
 
@@ -21,6 +22,7 @@ use True for logical unit tests,
 and use version-control for integration testing
 by comparing changes in output files.
 
+
 Install
 -------
 
@@ -32,166 +34,73 @@ in config.rb:
 
 `require 'true'`
 
-Usage
------
-
-Production example from
-[Susy Next](https://github.com/ericam/susy/blob/susy-next/test/scss/math/_columns.scss):
-
-```scss
-@import "true";
-
-// Column Math Tests
-// =================
-
-@include test-module('Column Math') {
-
-  // Is Symmetrical
-  // --------------
-
-  @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);
+Command Line
+-----
 
-    @include assert-equal($sum, 10,
-      'Column-sum for "(1 2 3 1 2) .25" should be "10".');
+`true-cli [options] PATH`
 
-    @include assert-equal($outer, 10.25,
-      'Outer column-sum for "(1 2 3 1 2) .25" should be "10.25".');
-  }
+Options:
+* `-s` slient
+* `-c` config file
+* `-d` debug config file settings
 
+Config file (optional):
 
-  // Get Columns
-  // -----------
+``` yaml
+options:
+  color: true #enables colored output
 
-  @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.');
-  }
+# require ruby sass extension libraries
+require:
+  - "compass"
+  - "serialy_sassy"
+```
 
-  @include test('[function] asymmetrical get-columns()') {
-    $span: 3;
-    $context: 1 2 3 1 2;
-    $sub: get-columns($span, 2, $context);
+default location: `test/true.yml`
 
-    @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".');
-  }
 
+Usage
+-----
 
-  // Get Column Span Sum
-  // -------------------
+```scss
+@import "true";
 
-  @include test('[function] symmetrical get-column-span-sum()') {
-    $cols: 12;
-    $guts: 1/8;
+@include test-module('Utilities') {
 
-    $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"');
+  @include test('Map Add [function]') {
+    $base: (one: 1, two: 1, three: 1);
+    $add: (one: 1, two: 2, three: -1);
 
-    $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".');
+    $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('[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".');
+  @include test('Strict Equal [function]') {
+    $test: is-equal(1, 1rem);
+    @include assert-equal($test, false,
+      'Returns false for equal numbers with different units.');
 
-    $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".');
+    $test: is-equal(1, 1);
+    @include assert-equal($test, true,
+      'Returns true for numbers that are truely equal.');
   }
-
 }
 ```
 
-**True** will report detailed results in the terminal,
-and a summary of results in the output css.
+**True** will report to both the terminal and an output css file by default.
 
-Here's the Susy "Column Math" CSS output:
+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) */
 /*
-
-### 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 */
+*/
+/* 2 Tests: */
+/*  - 2 Passed */
+/*  - 0 Failed */
 ```

data/VERSION

@@ -1 +1 @@
-0.2.2
+1.0.0

data/bin/true-cli

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+require 'sass'
+require 'true'
+require 'yaml'
+require 'optparse'
+COLORS = {
+  :ok => "\033[92m",
+  :fail => "\033[91m",
+  :end => "\033[0m"
+}
+options = {'debug' => false, 'slient' => false, 'color' => false}
+config_file = File.join(Dir.pwd, 'test', 'true.yml')
+OptionParser.new do |opts|
+  opts.banner = "Usage: true-cli [options] file"
+
+  opts.on('-c', '--config PATH', String, 'path to config file') do |config|
+    config_file  = config
+  end
+  opts.on('-d', '--debug') do
+    options['debug'] = true
+  end
+  opts.on('-s', '--slient') do
+    options['slient'] = true
+  end
+end.parse!(ARGV)
+
+
+def with_captured_stdout
+  begin
+    old_stderr = $stderr
+    $stderr = StringIO.new('', 'r+')
+    yield
+    $stderr.string
+  ensure
+    $stderr = old_stderr
+  end
+end
+output = with_captured_stdout do
+  ARGV.each do |file|
+    Sass::Engine.for_file(file, {}).render
+  end
+end
+
+if File.exists?(config_file)
+  puts "Using config file: #{config_file}" unless options['slient']
+  config_options = YAML.load(File.read(config_file))
+  options.merge!(config_options['options']) if config_options.has_key?('options')
+  if options['debug']
+    puts config_options.inspect
+  end
+  if config_options.has_key?('require')
+    config_options['require'].each do |path|
+      require path
+    end
+  end
+end
+
+if output.empty?
+  puts "No test files supplied"
+  exit(2)
+end
+
+matches = output.match(%r{(?<tests>\d+) Tests, (?<passed>\d+) Passed, (?<failed>\d+) Failed})
+
+if matches[:failed] == '0'
+  if options['color']
+    puts COLORS[:ok] + output + COLORS[:end] unless options['slient']
+  else
+    puts output unless options['slient']
+  end
+  exit(0)
+else
+  if options['color']
+    puts COLORS[:fail] + output + COLORS[:end] unless options['slient']
+  else
+    puts output unless options['slient']
+  end
+  exit(3)
+end

data/lib/true.rb

@@ -1,12 +1,9 @@
 true_stylesheets_path = File.expand_path(File.join(File.dirname(__FILE__), '..', 'sass'))
+ENV['SASS_PATH'] ||= ''
 begin
   require 'compass'
-  Compass::Frameworks.register('true', :stylesheets_directory => true_stylesheets_path)
+  ENV['SASS_PATH'] = ENV['SASS_PATH'] + File::PATH_SEPARATOR + Compass.configuration.sass_load_paths.join(File::PATH_SEPARATOR)
 rescue LoadError
-  # compass not found, register on the Sass path via the environment.
-  if ENV.key? 'SASS_PATH'
-    ENV['SASS_PATH'] += File::PATH_SEPARATOR + true_stylesheets_path
-  else
-    ENV['SASS_PATH'] = true_stylesheets_path
-  end
 end
+# compass not found, register on the Sass path via the environment.
+ENV['SASS_PATH'] += File::PATH_SEPARATOR + true_stylesheets_path

data/sass/true/_assert.scss

@@ -29,7 +29,7 @@
   $name: map-get($test-results, name);
   $debug-message: 'Expected: #{inspect($expected)}',
                   'Result: #{inspect($assert)}';
-  $result: if($assert == $expected, pass, fail);
+  $result: if(is-equal($assert, $expected), pass, fail);
   @include report-assert($name, $result, $fail-message, $debug-message...);
 }
 
@@ -41,8 +41,7 @@
   $name: map-get($test-results, name);
   $debug-message: 'Expected: #{inspect($expected)}',
                   'Result: #{inspect($assert)}';
-  $result: if($assert != $expected, pass, fail);
-
+  $result: if(is-equal($assert, $expected), fail, pass);
   @include report-assert($name, $result, $fail-message, $debug-message...);
 }
 
@@ -65,6 +64,9 @@
     @if $fail-message {
       @warn $fail-message;
     }
+
+    $test-details: $test-details + $-tnl + '  - error: '
+                   + '(#{$debug}) ' + $fail-message !global;
   }
 
   $test-results: map-add($test-results, (run: 1, $result: 1)) !global;

data/sass/true/_modules.scss

@@ -48,7 +48,7 @@ $module-results: null;
     $pass: map-get($module-results, pass);
     $fail: map-get($module-results, fail);
 
-    $css-message: '#{$run} Tests:\a - #{$pass} Passed\a - #{$fail} Failed';
+    $css-message: '#{$run} Tests:#{$-tnl} - #{$pass} Passed#{$-tnl} - #{$fail} Failed';
 
     @include spacer-comment;
     @include result-message($css-message, css);

data/sass/true/_tests.scss

@@ -2,6 +2,7 @@
 // =====
 
 $test-results: null;
+$test-details: '';
 
 // Establish a new test
 @mixin test(
@@ -9,9 +10,11 @@ $test-results: null;
   $output: map-get($true, output)
 ) {
   $test-results: map-merge($blank-results, (name: $name)) !global;
+  $test-details: '' !global;
   @content;
-  @include report-test($name, $test-results, $output);
+  @include report-test($name, $test-results, $output, $test-details);
   $test-results: null !global;
+  $test-details: '' !global;
 }
 
 // Report test results
@@ -20,7 +23,8 @@ $test-results: null;
 @mixin report-test(
   $name,
   $results,
-  $output: map-get($true, output)
+  $output: map-get($true, output),
+  $details: ''
 ) {
   $pass: map-get($results, pass);
   $fail: map-get($results, fail);
@@ -28,7 +32,7 @@ $test-results: null;
 
   $message: '#{$name} (#{report($results, Assertions)})';
 
-  @include test-result($result, $message, $output);
+  @include test-result($result, $message, $output, $details);
 }
 
 // Pass / Fail Tests
@@ -37,14 +41,15 @@ $test-results: null;
 @mixin test-result(
   $result,
   $message: '',
-  $output: map-get($true, output)
+  $output: map-get($true, output),
+  $details: ''
 ) {
   $css: null;
   $terminal: null;
 
   @if $result == fail {
     $message: if($message, $message, map-get($true, fail));
-    $css: '- FAIL: ' + if($message, $message, '');
+    $css: '- FAIL: ' + if($message, $message, '') + $details;
     $terminal: 'FAIL: ' + if($message, $message, '');
   } @else if $result == pass {
     $message: if($message, $message, map-get($true, pass));

data/sass/true/_utilities.scss

@@ -17,26 +17,6 @@
   @return $base;
 }
 
-// Return a map as a string
-@function map-to-string(
-  $map
-) {
-  @if type-of($map) != map {
-    @return $map;
-  } @else {
-    $return: '(';
-    $i: 1;
-    @each $key, $value in $map {
-      $return: $return + '#{$key}: #{$value}';
-      @if $i < length(map-keys($map)) {
-        $return: $return + ', ';
-      }
-      $i: $i + 1;
-    }
-    @return $return + ')';
-  }
-}
-
 // Split a string
 @function str-split($string, $substring) {
   $strings: ();
@@ -49,3 +29,12 @@
   $strings: append($strings, $string);
   @return $strings;
 }
+
+// Check for strict equality
+@function 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;
+  }
+}

metadata

@@ -1,10 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: 'true'
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 1.0.0
 platform: ruby
 authors:
-- Eric Meyer
+- Eric Suzanne
+- Scott Davis
+- Chris Eppstein
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -14,26 +16,23 @@ dependencies:
   name: sass
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.3.0
-    - - <
-      - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 3.3.0
-    - - <
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.4'
 description: Unit tests for maintaining test-driven Sass libraries.
 email:
 - eric@oddbird.net
-executables: []
+- me@sdavis.info
+- chris@eppsteins.net
+executables:
+- true-cli
 extensions: []
 extra_rdoc_files:
 - CHANGELOG.md
@@ -55,7 +54,8 @@ files:
 - LICENSE.txt
 - README.md
 - VERSION
-homepage: http://eric.andmeyer.com/true
+- bin/true-cli
+homepage: http://ericsuzanne.com/true
 licenses: []
 metadata: {}
 post_install_message: 
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '1.2'
 requirements: []
 rubyforge_project: 'true'
-rubygems_version: 2.0.3
+rubygems_version: 2.1.10
 signing_key: 
 specification_version: 3
 summary: Testing framework for Sass libraries.