true 2.1.3 → 2.2.0

data/sass/true/_settings.scss

@@ -1,79 +1,12 @@
 // True Settings
 // =============
 
+
+
+// Terminal Output
+// ---------------
 /// 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: ();
-
-/// 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
-) {
-  $_true-context: append($_true-context, ($scope, $name)) !global;
-}
-
-@mixin _true-context-pop() {
-  $new: ();
-  @for $i from 1 to length($_true-context) {
-    $new: append($new, nth($_true-context, $i));
-  }
-  $_true-context: $new !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
-) {
-  @for $i from length($_true-context) through 1 {
-    $entry: nth($_true-context, $i);
-    $entry-scope: nth($entry, 1);
-    @if $entry-scope == $scope {
-      @return nth($entry, 2);
-    }
-  }
-  @return null;
-}
-
-/// Get list of context names
-/// @access private
-/// @group x_private
-/// @param {String} $scope - Either `module`, `test` or `assert`
-/// @return {List}
-@function _true-context-all(
-  $scope
-) {
-  $list: ();
-  @for $i from 1 through length($_true-context) {
-    $entry: nth($_true-context, $i);
-    $entry-scope: nth($entry, 1);
-    @if $entry-scope == $scope {
-      $list: append($list, nth($entry, 2));
-    }
-  }
-  @return $list;
-}

data/sass/true/_tests.scss

@@ -1,13 +1,14 @@
 // Tests
 // =====
 
+
+
+// Test
+// ----
 /// 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
@@ -18,15 +19,12 @@
 }
 
 
-// Module Start (private)
-// ----------------------
 
+// Test Start
+// ----------
 /// Test start helper
 /// @access private
-/// @group x_private
 /// @param {String} $name - Test name
-/// @require {mixin} _true-context
-/// @require {mixin} _true-message
 @mixin _true-test-start(
   $name
 ) {
@@ -35,16 +33,13 @@
 }
 
 
-// Module Stop (private)
-// ---------------------
 
+// Test Stop
+// ---------
 /// Test stop helper
 /// @access private
-/// @group x_private
-/// @require {mixin} _true-context
-/// @require {mixin} _true-message
-/// @require {function} _true-get-result
 @mixin _true-test-stop {
+  @include _true-update($_true-test-result);
   @include _true-context-pop();
   @include _true-message('', 'comments');
 }

data/sass/true/_utilities.scss

@@ -1,11 +1,16 @@
 // Utilities
 // =========
 
+
+
+// Map Increment
+// -------------
 /// Add map values together
 /// @access private
-/// @group x_private
-/// @param {Map} $base - Initial map
-/// @param {Map} $add - Extra map
+/// @param {Map} $base -
+///   Initial map to add values to
+/// @param {Map} $add -
+///   Map of values to be added
 /// @return {Map}
 @function _true-map-increment(
   $base,
@@ -24,12 +29,18 @@
   @return $base;
 }
 
-/// Split a string
+
+
+// String Split
+// ------------
+/// Split a string into a list
 /// @access private
-/// @group x_private
-/// @param {String} $string - String to split
-/// @param {String} $substring - Delimiter
-/// @return {List} - `$string` fragments
+/// @param {String} $string -
+///   String to split
+/// @param {String} $substring -
+///   Delimiter
+/// @return {List} -
+///   List of string fragments
 @function _true-str-split(
   $string,
   $substring
@@ -45,12 +56,18 @@
   @return $strings;
 }
 
-/// Join a list of strings
+
+
+// String Join
+// -----------
+/// Join a list of strings into a single string
 /// @access private
-/// @group x_private
-/// @param {List} $list - List to join
-/// @param {String} $separator - Separator
-/// @return {String} - Joined string
+/// @param {List} $list -
+///   List of strings to join
+/// @param {String} $separator -
+///   Separator to add between items
+/// @return {String} -
+///   Joined string
 @function _true-str-join(
   $list,
   $separator
@@ -71,11 +88,15 @@
 }
 
 
-/// Check for strict equality
+
+// Is Equal
+// --------
+/// Check for equality, excluding comparable numbers
 /// @access private
-/// @group x_private
-/// @param {*} $one - First value
-/// @param {*} $two - Second value
+/// @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' {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: 'true'
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.2.0
 platform: ruby
 authors:
 - Miriam Eric Suzanne
@@ -45,6 +45,7 @@ files:
 - lib/true.rb
 - sass/_true.scss
 - sass/true/_assert.scss
+- sass/true/_context.scss
 - sass/true/_messages.scss
 - sass/true/_modules.scss
 - sass/true/_results.scss