true 2.0.0.beta.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82b889e126441092c78fae0935640eddff42dd26
-  data.tar.gz: 5ced6822242622c9d5b2c535a020595c4e27af45
+  metadata.gz: 5c0548977f5e351aeab7f465291096de0ef682ad
+  data.tar.gz: 00540f1f8028c954a5bd0692af85f1131b277ea9
 SHA512:
-  metadata.gz: 5a0aefdab1acf74ad6a17293014f084f626f16d858ea61fa6b54f67ba066889c0de896d0613907d8d1e6ef26d10e74a024b7d10b395fd0e0d07642f681d46e44
-  data.tar.gz: e170d9287c8043791a2936dd894aad9c7a3c3a1e6553e5fddb944de40df1535f1bbc0975dd704616c17dbae8d1958e18fb8d44de17817da761b7dc7ff4e83219
+  metadata.gz: ebd45186a8a05fa15002cecd3b98d034c7117cb48009dbf92ccd667ad03786d8557be6538eb8fcb475b17827a4eb5e3a1798b680ad6cbc453b07fb8639991a81
+  data.tar.gz: 55bc4bbfb19d2eaf0d4f34c140ac828ef8c87c3fc3680107a0005cc18594dba8f924dd51aa2d9a3db453d8e5ed8370dd6a7edbe7a03a2a2a2fdb64ea1f64393d

data/CHANGELOG.md

@@ -1,15 +1,14 @@
 True Changelog
 ==============
 
-2.0 (unreleased)
-----------------
+2.0 (5/9/15)
+------------
 - Improve internal logic, and namespace private functions behind `_true-*`.
 - Add `assert()`, `input`, and `expect` mixins for testing CSS output.
 - Support for LibSass.
 - Add Mocha JS integration.
 — Create NPM package.
 - Simplify output options down to single `$true-terminal-output` setting.
-  Defaults to `false` (required for libsass).
 
 
 1.0.1 (10/18/14)

data/README.md

@@ -12,10 +12,6 @@ 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 (e.g. function returns),
-not property/value output (e.g. mixin output).
-
 
 Install
 -------
@@ -28,14 +24,84 @@ gem install true
 
 # bower package
 bower install true
+
+# npm module
+npm install sass-true
+```
+
+Usage
+-----
+
+### In Sass
+
+```scss
+@import "true";
+
+@include test-module('Utilities') {
+
+  // Testing Functions
+  @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');
+  }
+
+  // Testing Mixins
+  @include test('Font Size [mixin]') {
+    @include assert('Outputs a font size and line height based on keyword.') {
+      @include input {
+        @include font-size(large);
+      }
+
+      @include expect {
+        font-size: 2rem;
+        line-height: 3rem;
+      }
+    }
+  }
+}
+
+// Optionally show summary report in CSS and/or the command line:
+// - If you use Mocha, reporting to the command line is automatic.
+// - if you use true-cli, report(terminal) is required for output.
+@include report;
 ```
 
+### With node-sass and Mocha (or other JS test runners)
+
+1. Install `true` via npm (`npm install sass-true`).
+
+2. Write some Sass tests in `test/test.scss` (see above).
+
+3. Write a shim JS test file in `test/test_sass.js`:
 
-Command Line
-------------
+   ```js
+   var path = require('path');
+   var true = require('sass-true');
 
-_This command-line tool uses Ruby
-and the Ruby Sass compiler._
+   var sassFile = path.join(__dirname, 'test.scss');
+   true.runSass({file: sassFile}, describe, it);
+   ```
+
+4. Run Mocha, and see your Sass tests reported as individual test results.
+
+You can call `runSass` more than once, if you have multiple Sass test files you
+want to run separately.
+
+The first argument to `runSass` accepts the same options that node-sass'
+`renderSync` function accepts. The only modification `runSass` makes is to add
+True's sass path to the `includePaths` option, so `@import 'true';` works in
+your Sass test file.
+
+Any other JS test runner with equivalents to Mocha's `describe` and `it` should
+be usable in the same way; just pass your test runner's `describe` and `it`
+equivalents into `runSass`.
+
+### With ruby-sass on the command line
 
 ```bash
 true-cli [options] PATH
@@ -50,7 +116,7 @@ Config file (optional):
 
 ```yaml
 options:
-  color: true #enables colored output
+  color: true  # enables colored output
 
 # require ruby sass extension libraries
 require:
@@ -61,47 +127,13 @@ require:
 default location: `test/true.yml`
 
 
-Usage
------
-
-```scss
-@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`
-toggles output to the terminal on and off.
+toggles output to the terminal on or off.
 
-- `true` will display a final summary of your test results in the terminal,
-  and show detailed information on failing assertions.
-  *Required for `true-cli`.*
+- `true` will show detailed information on failing assertions.
+  This is the default, and best for using `true-cli`.
 - `false` to turn off all terminal output.
-  *Required for Libsass.*

data/VERSION

@@ -1 +1 @@
-2.0.0.beta.0
+2.0.0

data/lib/main.js

@@ -1,5 +1,6 @@
 var _ = require('underscore');
 var parseCss = require('css').parse;
+var path = require('path');
 var sass = require('node-sass');
 var CssSelectorParser = require('css-selector-parser').CssSelectorParser;
 var selectorParser = new CssSelectorParser();
@@ -10,7 +11,13 @@ var selectorParser = new CssSelectorParser();
 
 module.exports.runSass = function (options, describe, it) {
   var assert = require('assert');
-  var css = sass.renderSync(options);
+  var sassPath = path.join(__dirname, '..', 'sass');
+  if (options.includePaths) {
+    options.includePaths.push(sassPath);
+  } else {
+    options.includePaths = [sassPath];
+  }
+  var css = sass.renderSync(options).css.toString();
   var modules = parse(css);
 
   _.each(modules, function (module) {

data/sass/true/_messages.scss

@@ -26,7 +26,7 @@ $-tnl: "\a ";
 }
 
 
-// Output a message to CSS, Terminal, or Comments
+// Output a message to CSS comments, or command line terminal (via debug/warn)
 @mixin _true-message(
   $message,
   $output: comments

data/sass/true/_settings.scss

@@ -1,7 +1,7 @@
 // True Settings
 // =============
 
-$true-terminal-output: false !default;
+$true-terminal-output: true !default;
 
 
 // Context (private)

data/sass/true/_utilities.scss

@@ -48,30 +48,3 @@
     @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: 2.0.0.beta.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Eric Suzanne
@@ -76,9 +76,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '1.2'
 requirements: []
 rubyforge_project: 'true'
 rubygems_version: 2.1.10