true 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c7419203ee20695de7342c8895c194653849fef
-  data.tar.gz: 36a072e2571696c309b2ce6ac643460d12335cca
+  metadata.gz: f6a7100c98f736aaf9d6ef973ba5c5fc0231acdd
+  data.tar.gz: 9a6425828c5a712a6735d26d36c51fe7c9ae331a
 SHA512:
-  metadata.gz: e169139c289eaafc4d529bdfbfb4611c4498ac5ad8e3e53cae029677d1aeeca2a46a8ea3eebb93882942c1bfd04602ca85f67e47c6f011c0a5fa39d0fc01c137
-  data.tar.gz: af25cf305548e161018cd3dd894584ab47cd279f12f8c8c6d303e10e51e04d37c83cc1f16ae7955b62d2d7f78ed8a6ee2d80e2603e6f57fceae395c64e07aa4f
+  metadata.gz: 9dba31e95f10290485d251692881ea8af645bbe075d9a9820646f417f98cc8fe4a335339b5733bc9897ae3a60116c6c999b2af2bf0625bd59dde1eaa1c09c55b
+  data.tar.gz: 15de231bffdd88378eb45908d6b3e473f019389fee8aa428bc57d6409e44c7a03d8db8b9dc612d0aed63ed81c60eed1a5c02fe5d00f72296c1f084d9f8e5cbdc

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 True Changelog
 ==============
 
+
+2.0.2 (5/13/15)
+---------------
+- Fixes debug inspector.
+
+
 2.0.1 (5/9/15)
 --------------
 - Improve internal logic, and namespace private functions behind `_true-*`.

data/sass/true/_assert.scss

@@ -2,6 +2,14 @@
 // ======
 
 
+/// Assert that a parameter is `true`
+/// @access public
+/// @group testing
+/// @param {*} $assert - Assert
+/// @param {String} $description [''] - Assert description
+/// @require {mixin} _true-fail-details
+/// @require {mixin} _true-assert-start
+/// @require {mixin} _true-assert-stop
 @mixin assert-true(
   $assert,
   $description: ''
@@ -21,7 +29,14 @@
   @include _true-assert-stop($result);
 }
 
-
+/// Assert that a parameter is `false`
+/// @access public
+/// @group testing
+/// @param {*} $assert - Assert
+/// @param {String} $description [''] - Assert description
+/// @require {mixin} _true-fail-details
+/// @require {mixin} _true-assert-start
+/// @require {mixin} _true-assert-stop
 @mixin assert-false(
   $assert,
   $description: ''
@@ -41,7 +56,15 @@
   @include _true-assert-stop($result);
 }
 
-
+/// /// Assert that two parameters are `equal`
+/// @access public
+/// @group testing
+/// @param {*} $assert - Assert
+/// @param {*} $expected - Expected result
+/// @param {String} $description [''] - Assert description
+/// @require {mixin} _true-fail-details
+/// @require {mixin} _true-assert-start
+/// @require {mixin} _true-assert-stop
 @mixin assert-equal(
   $assert,
   $expected,
@@ -62,7 +85,15 @@
   @include _true-assert-stop($result);
 }
 
-
+/// Assert that two parameters are `unequal`
+/// @access public
+/// @group testing
+/// @param {*} $assert - Assert
+/// @param {*} $expected - Expected result
+/// @param {String} $description [''] - Assert description
+/// @require {mixin} _true-fail-details
+/// @require {mixin} _true-assert-start
+/// @require {mixin} _true-assert-stop
 @mixin assert-unequal(
   $assert,
   $expected,
@@ -87,6 +118,14 @@
 // CSS Output Tests
 // ----------------
 
+/// Define a CSS-output assertion
+/// @access public
+/// @group testing
+/// @param {String} $description - Assert description
+/// @content Use `input()` and `expect()` mixins to define blocks for comparison
+/// @require {mixin} _true-assert-start
+/// @require {mixin} _true-assert-stop
+/// @require {function} _true-selector
 @mixin assert(
   $description
 ) {
@@ -99,12 +138,20 @@
   @include _true-assert-stop(output-to-css);
 }
 
+/// Describe the test content to be evaluated
+/// The output will be compared against the results of the `expect()` mixin.
+/// @access public
+/// @group testing
 @mixin input {
   .input {
     @content;
   }
 }
 
+/// Describe the output content to be expected.
+/// The output will be compared against the results of the `input()` mixin.
+/// @access public
+/// @group testing
 @mixin expect {
   .expect {
     @content;
@@ -115,12 +162,23 @@
 // Assert Start
 // ------------
 
+/// True assert start helper
+/// @access private
+/// @group x_private
+/// @param {String} $name - Assert name
+/// @require {mixin} _true-context
 @mixin _true-assert-start(
   $name
 ) {
   @include _true-context(assert, $name);
 }
 
+/// True assert sort helper
+/// @access private
+/// @group x_private
+/// @param {String} $result - Assert result
+/// @require {mixin} _true-context
+/// @require {mixin} _true-update
 @mixin _true-assert-stop(
   $result
 ) {
@@ -132,6 +190,14 @@
 // Details
 // -------
 
+/// Fail details
+/// @access private
+/// @group x_private
+/// @param {*} $expected - Expected result
+/// @param {*} $returned - Returned result
+/// @param {Bool} $terminal [$true-terminal-output] - Whether or not to use terminal output
+/// @require $true-terminal-output
+/// @require {function} _true-context
 @mixin _true-fail-details(
   $expected,
   $returned,
@@ -140,15 +206,15 @@
   $expected-type: type-of($expected);
   $returned-type: type-of($returned);
 
-  -expected--#{$expected-type}: _true-inspect($expected);
-  -returned--#{$returned-type}: _true-inspect($returned);
+  -expected--#{$expected-type}: inspect($expected);
+  -returned--#{$returned-type}: inspect($returned);
 
   @if $terminal {
     @debug '[FAIL] #{_true-context(test)} » #{_true-context(assert)}';
     @debug 'Expected #{$expected-type} »';
-    @debug _true-inspect($expected);
+    @debug inspect($expected);
     @debug 'Returned #{$returned-type} »';
-    @debug _true-inspect($returned);
+    @debug inspect($returned);
   }
 
   @warn '#{_true-context(test)} » #{_true-context(assert)}';

data/sass/true/_messages.scss

@@ -1,10 +1,19 @@
 // Messages
 // ========
 
-$-tnl: "\a ";
+/// New line helper
+/// @access private
+/// @group x_private
+/// @type String
+$-tnl: '\a ';
 
 
-// Return a CSS selector for the current context
+/// Return a CSS selector for the current context
+/// @access private
+/// @group x_private
+/// @param {List} $scope - Scope
+/// @require {function} _true-context
+/// @return {String} - CSS selector
 @function _true-selector(
   $scope
 ) {
@@ -19,14 +28,22 @@ $-tnl: "\a ";
 }
 
 
-// Output a spacer comment
+/// Output a spacer comment
+/// @access private
+/// @group x_private
+/// @output A spacer comment
 @mixin _true-spacer() {
 /*
 */
 }
 
 
-// Output a message to CSS comments, or command line terminal (via debug/warn)
+/// Output a message to CSS comments, or command line terminal (via debug/warn)
+/// @access private
+/// @group x_private
+/// @param {String} $message - Message to output
+/// @param {String} $output [comments] - Type of output, either `comments`, `terminal`, `debug` or `warn`
+/// @require {function} _true-str-split
 @mixin _true-message(
   $message,
   $output: comments

data/sass/true/_modules.scss

@@ -1,7 +1,13 @@
 // Test Module
 // ===========
 
-
+/// Define a Test Module
+/// @access public
+/// @group testing
+/// @param {String} $name - Module name
+/// @require {mixin} _true-module-start
+/// @require {mixin} _true-module-stop
+/// @content Include all the tests that are part of this module
 @mixin test-module(
   $name
 ) {
@@ -14,6 +20,13 @@
 // Module Start (private)
 // ----------------------
 
+/// Module start helper
+/// @access private
+/// @group x_private
+/// @param {String} $name - Module name
+/// @require {mixin} _true-reset
+/// @require {mixin} _true-context
+/// @require {mixin} _true-message
 @mixin _true-module-start(
   $name
 ) {
@@ -26,6 +39,12 @@
 // Module Stop (private)
 // ---------------------
 
+/// Module stop helper
+/// @access private
+/// @group x_private
+/// @require {mixin} _true-reset
+/// @require {mixin} _true-context
+/// @require {mixin} _true-message
 @mixin _true-module-stop {
   @include _true-update(global, null);
   @include _true-reset(module);

data/sass/true/_results.scss

@@ -1,6 +1,10 @@
 // Results
 // =======
 
+/// Initialized results map
+/// @access private
+/// @group x_private
+/// @type Map
 $_true-results-reset: (
   run: 0,
   pass: 0,
@@ -8,6 +12,14 @@ $_true-results-reset: (
   output-to-css: 0,
 );
 
+/// Results map
+/// @access private
+/// @group x_private
+/// @type Map
+/// @require $_true-results-reset
+/// @prop {Map} global [$_true-results-reset] - Global results
+/// @prop {Map} module [$_true-results-reset] - Results for current module
+/// @prop {Map} test [$_true-results-reset] - Results for current test
 $_true-results: (
   global: $_true-results-reset,
   module: $_true-results-reset,
@@ -18,6 +30,12 @@ $_true-results: (
 // Reset
 // -----
 
+/// Reset helper
+/// @access private
+/// @group x_private
+/// @param {String} $scope - Scope to reset
+/// @require $_true-results-reset
+/// @require $_true-results
 @mixin _true-reset(
   $scope
 ) {
@@ -47,6 +65,11 @@ $_true-results: (
 // Get Results
 // -----------
 
+/// Results getter
+/// @access private
+/// @group x_private
+/// @param {String} $scope - Scope to get results from
+/// @require $_true-results
 @function _true-get-results(
   $scope
 ) {
@@ -57,6 +80,11 @@ $_true-results: (
 // Get Result
 // ----------
 
+/// Single result getter
+/// @access private
+/// @group x_private
+/// @param {String} $scope - Scope to get result form
+/// @require {function} _true-get-results
 @function _true-get-result(
   $scope
 ) {
@@ -76,6 +104,14 @@ $_true-results: (
 // Update
 // ------
 
+/// Update results
+/// @access private
+/// @group x_private
+/// @param {String} $scope - Scope to update results from
+/// @param {List} $results - Results
+/// @require {function} _true-get-results
+/// @require {function} _true-map-increment
+/// @require $_true-results
 @mixin _true-update(
   $scope,
   $results
@@ -101,6 +137,13 @@ $_true-results: (
 // Report Message
 // --------------
 
+/// Report message
+/// @access private
+/// @group x_private
+/// @param {String} $scope [test] - Scope
+/// @param {String} $lines [single] - Lines
+/// @return {String} - Reported message
+/// @require {function} _true-get-results
 @function _true-report-message(
   $scope: test,
   $lines: single
@@ -135,6 +178,12 @@ $_true-results: (
 // Report
 // ------
 
+/// Report results summary to CSS and/or command line
+/// @access public
+/// @group reporting
+/// @param {Bool} $terminal [$true-terminal-output] - Whether or not to use terminal output
+/// @require {function} _true-report-message
+/// @require {function} _true-message
 @mixin report(
   $terminal: $true-terminal-output
 ) {

data/sass/true/_settings.scss

@@ -1,18 +1,35 @@
 // True Settings
 // =============
 
+/// Whether or not to use the terminal as output stream
+/// @access public
+/// @group reporting
+/// @type Bool
 $true-terminal-output: true !default;
 
 
 // Context (private)
 // -----------------
 
+/// True current context
+/// @access private
+/// @group x_private
+/// @type Map
+/// @prop {String} module [null]
+/// @prop {String} test [null]
+/// @prop {String} assert [null]
 $_true-context: (
   module: null,
   test: null,
   assert: null,
 );
 
+/// Update the current context
+/// @access private
+/// @group x_private
+/// @param {String} $scope - Either `module`, `test` or `assert`
+/// @param {String} $name - Name of current scope
+/// @require $_true-context
 @mixin _true-context(
   $scope,
   $name
@@ -20,6 +37,11 @@ $_true-context: (
   $_true-context: map-merge($_true-context, ($scope: $name)) !global;
 }
 
+/// Get information on current context
+/// @access private
+/// @group x_private
+/// @param {String} $scope - Either `module`, `test` or `assert`
+/// @return {String}
 @function _true-context(
   $scope
 ) {

data/sass/true/_tests.scss

@@ -1,7 +1,14 @@
 // Tests
 // =====
 
-
+/// Describe a Test
+/// @access public
+/// @group testing
+/// @param {String} $name - Test bame
+/// @require {mixin}_true-test-start
+/// @require {mixin}_true-test-stop
+/// @require {function} _true-selector
+/// @content Include the assertions that are part of this test
 @mixin test(
   $name
 ) {
@@ -17,6 +24,13 @@
 // Module Start (private)
 // ----------------------
 
+/// Test start helper
+/// @access private
+/// @group x_private
+/// @param {String} $name - Test name
+/// @require {mixin} _true-reset
+/// @require {mixin} _true-context
+/// @require {mixin} _true-message
 @mixin _true-test-start(
   $name
 ) {
@@ -29,6 +43,13 @@
 // Module Stop (private)
 // ---------------------
 
+/// Test stop helper
+/// @access private
+/// @group x_private
+/// @require {mixin} _true-reset
+/// @require {mixin} _true-context
+/// @require {mixin} _true-message
+/// @require {function} _true-get-result
 @mixin _true-test-stop {
   @include _true-update(module, _true-get-result(test));
   @include _true-reset(test);

data/sass/true/_utilities.scss

@@ -1,7 +1,12 @@
 // Utilities
 // =========
 
-// Add map values together
+/// Add map values together
+/// @access private
+/// @group x_private
+/// @param {Map} $base - Initial map
+/// @param {Map} $add - Extra map
+/// @return {Map}
 @function _true-map-increment(
   $base,
   $add
@@ -19,7 +24,12 @@
   @return $base;
 }
 
-// Split a string
+/// Split a string
+/// @access private
+/// @group x_private
+/// @param {String} $string - String to split
+/// @param {String} $substring - Delimiter
+/// @return {List} - `$string` fragments
 @function _true-str-split(
   $string,
   $substring
@@ -36,7 +46,12 @@
 }
 
 
-// Check for strict equality
+/// Check for strict equality
+/// @access private
+/// @group x_private
+/// @param {*} $one - First value
+/// @param {*} $two - Second value
+/// @return {Bool}
 @function _true-is-equal($one, $two) {
   @if type-of($one) == number and type-of($two) == number {
     @if unit($one) == unit($two) {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: 'true'
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Eric Suzanne