SassyStrings 1.1.3 → 1.1.4

data/stylesheets/private/_str-lcfirst.scss

@@ -1,15 +1,7 @@
-/*
- * Lower case first character of $string
- * ---
- * @access private
- * ---
- * @since 1.2.0
- * ---
- * @param {string} $string - string to lower the first character
- * ---
- * @return {string}
- */
-
+/// Lower case first character of `$string`.
+/// @since 1.2.0
+/// @param {String} $string - string to lower the first character
+/// @return {String}
 @function _ss-str-lcfirst($string) {
   @return to-lower-case(str-slice($string, 1, 1)) + str-slice($string, 2);
-}
+}

data/stylesheets/private/_str-pad.scss

@@ -1,20 +1,11 @@
-/*
- * Pad $string from $direction with $pad to reach $length characters
- * ---
- * @access public
- * ---
- * @since 1.2.0
- * ---
- * @param {string} $string    - string to pad
- * @param {number} $length    - number of characters to go for in returned string
- * @param {string} $pad       - string to use to pad $string
- * @param {string} $direction - direction left or right for padding
- * ---
- * @return {string}
- */
-
+/// Pad `$string` from `$direction` with `$pad` to reach `$length` characters.
+/// @since 1.2.0
+/// @param {String} $string           - string to pad
+/// @param {Number} $length           - number of characters to go for in returned string
+/// @param {String} $pad       (" ")  - string to use to pad `$string`
+/// @param {String} $direction (left) - direction left or right for padding
+/// @return {String}
 @function _ss-str-pad($string, $length, $pad: " ", $direction: left) {
-  $direction: if(index(left right, $direction), $direction, left);
   $new-string: $string;
   $index: 1;
 
@@ -22,15 +13,15 @@
     @while str-length($new-string) < $length {
       $remains: $length - str-length($new-string);
       $pad: if($remains < str-length($pad), str-slice($pad, 1, $remains), $pad);
+
       @if $direction == left {
         $new-string: str-insert($new-string, $pad, $index);
         $index: $index + str-length($pad);
-      }
-      @else {
+      } @else {
         $new-string: $new-string + $pad;
       }
     }
   }
 
   @return $new-string;
-}
+}

data/stylesheets/private/_str-printf.scss

@@ -1,26 +1,17 @@
-/*
- * Replace occurrences of %s in $string by $elements
- * ---
- * @access private
- * ---
- * @since 1.2.0
- * ---
- * @param {string}  $string   - string to check
- * @param {arglist} $elements - strings to use for replacements in %s
- * ---
- * @return {string}
- */
-
+/// Replace occurrences of `%s` in `$string` by `$elements`.
+/// @since 1.2.0
+/// @param {String}  $string   - string to check
+/// @param {Arglist} $elements - strings to use for replacements in `%s`
+/// @return {String}
 @function _ss-str-printf($string, $elements...) {
-  $breaker: '%s'; 
+  $breaker: "%s";
   $result: $string;
 
-  @for $i from 1 through length($elements) {
+  @each $element in $elements {
     $index: str-index($result, $breaker);
     @if $index {
-      $result: str-slice($result, 1, $index - 1) + _ss-stringify(nth($elements, $i)) + str-slice($result, $index + str-length($breaker));
-    }
-    @else {
+      $result: str-slice($result, 1, $index - 1) + _ss-stringify($element) + str-slice($result, $index + str-length($breaker));
+    } @else {
       @return $result;
     }
   }

data/stylesheets/private/_str-repeat.scss

@@ -1,16 +1,8 @@
-/*
- * Repeat $string $times times
- * ---
- * @access private
- * ---
- * @since 1.2.0
- * ---
- * @param {string} $string - string to repeat
- * @param {number} $times  - number of times to repeat $string
- * ---
- * @return {string|false}
- */
-
+/// Repeat `$string` `$times` times.
+/// @since 1.2.0
+/// @param {String} $string - string to repeat
+/// @param {Number} $times  - number of times to repeat $string
+/// @return {String}
 @function _ss-str-repeat($string, $times) {
   $result: "";
 
@@ -19,4 +11,4 @@
   }
 
   @return $result;
-}
+}

data/stylesheets/private/_str-replace.scss

@@ -1,33 +1,15 @@
-/*
- * Replace $old occurrences by $new in $string respecting $case-sensitive
- * ---
- * @access private
- * ---
- * @since 1.2.0
- * ---
- * @param {string} $string         - string
- * @param {string} $old            - old substring to replace by $new
- * @param {string} $new            - new substring to replace $old
- * @param {bool}   $case-sensitive - case-sensitivity
- * ---
- * @return {string}
- */
-
-@function _ss-str-replace($string, $old, $new: '', $case-sensitive: true) {
-  $index: if(not $case-sensitive, str-index(to-lower-case($string), to-lower-case($old)),  str-index($string, $old));
-
-  @if $index and $new != $old {
-    $result: if($index != 1, quote(str-slice($string, 1, $index - 1)), '');
-
-    @for $i from $index through str-length($string) {
-      @if $i < $index or $i >= $index + str-length($old) {
-        $result: $result + str-slice($string, $i, $i);
-      }
-    }
-
-    @return quote(_ss-str-replace(str-insert($result, $new, $index), $old, $new, $case-sensitive)); 
+/// Replace `$search` with `$replace` in `$string`.
+/// @since 1.2.0
+/// @param {String} $string - Initial string
+/// @param {String} $search - Substring to replace
+/// @param {String} $replace ("") - New value
+/// @return {String} - Updated string
+@function _ss-str-replace($string, $search, $replace: "") {
+  $index: str-index($string, $search);
+
+  @if $index {
+    @return str-slice($string, 1, $index - 1) + $replace + _ss-str-replace(str-slice($string, $index + str-length($search)), $search, $replace);
   }
 
   @return $string;
 }
-

data/stylesheets/private/_str-reverse.scss

@@ -1,21 +1,13 @@
-/*
- * Reverse $string
- * ---
- * @access private
- * ---
- * @since 1.2.0
- * ---
- * @param {string} $string - string to reverse
- * ---
- * @return {string} 
- */
-
+/// Reverse `$string`.
+/// @since 1.2.0
+/// @param {String} $string - string to reverse
+/// @return {String}
 @function _ss-str-reverse($string) {
   $result: "";
 
-  @for $i from str-length($string) * -1 through -1 {
-    $result: $result + str-slice($string, abs($i), abs($i));
+  @for $i from str-length($string) through 1 {
+    $result: $result + str-slice($string, $i, $i);
   }
 
   @return $result;
-}
+}

data/stylesheets/private/_str-rot.scss

@@ -1,28 +1,19 @@
-/*
- * Rotate all characters from the alphabet in $string by $rot positions
- * ---
- * @access private
- * ---
- * @since 1.2.0
- * ---
- * @param {string} $string - string to rotate
- * @param {number} $rot    - number of positions to switch in alphabet
- * ---
- * @return {string}
- */
-
+/// Rotate all characters from the alphabet in `$string` by `$rot` positions.
+/// @since 1.2.0
+/// @param {String} $string   - string to rotate
+/// @param {Number} $rot (13) - number of positions to switch in alphabet
+/// @return {String}
 @function _ss-str-rot($string, $rot: 13) {
   $alphabet: a b c d e f g h i j k l m n o p q r s t u v w x y z;
   $result: "";
-  $rot: if(type-of($rot) == "number", floor($rot), 13);
 
   @for $i from 1 through str-length($string) {
     $char: str-slice($string, $i, $i);
     $index: index($alphabet, to-lower-case($char));
     $is-caps: $index and (index($alphabet, to-lower-case($char)) != index($alphabet, $char));
-    $new-char: if($index, 
-      if($index + $rot > length($alphabet), 
-        nth($alphabet, $index + $rot - length($alphabet)), 
+    $new-char: if($index,
+      if($index + $rot > length($alphabet),
+        nth($alphabet, $index + $rot - length($alphabet)),
         nth($alphabet, $index + $rot)
       ),
       $char
@@ -36,4 +27,4 @@
   }
 
   @return $result;
-}
+}

data/stylesheets/private/_str-shuffle.scss

@@ -1,36 +1,22 @@
-/*
- * Shuffle characters from $string
- * ---
- * @access private
- * ---
- * @since 1.2.0
- * ---
- * @param {string} $string - string to shuffle
- * ---
- * @return {string}
- */
-
+/// Shuffle characters from `$string`.
+/// @since 1.2.0
+/// @param {String} $string - string to shuffle
+/// @return {String}
 @function _ss-str-shuffle($string) {
-    @return str-implode(_ss-shuffle(str-explode($string)));
+  @return str-implode(_ss-shuffle(str-explode($string)));
 }
 
-/*
- * Shuffle a list
- * ---
- * @access private
- * ---
- * @param {list} $list - shuffle a list
- * ---
- * @return {list}
- */
-
+/// Shuffle a list
+/// @access private
+/// @param {List} $list - shuffle a list
+/// @return {List}
 @function _ss-shuffle($list) {
-    @for $i from -1 * length($list) through -1 {
-        $i: abs($i);
-        $j: random(length($list) - 1) + 1;
-        $tmp: nth($list, $i);
-        $list: set-nth($list, $i, nth($list, $j));
-        $list: set-nth($list, $j, $tmp);
-    }
-    @return $list;
+  @for $i from length($list) through 1 {
+    $j: random(length($list) - 1) + 1;
+    $tmp: nth($list, $i);
+    $list: set-nth($list, $i, nth($list, $j));
+    $list: set-nth($list, $j, $tmp);
+  }
+
+  @return $list;
 }

data/stylesheets/private/_str-starts-with.scss

@@ -1,16 +1,8 @@
-/*
- * Check whether $string stars with $needle
- * ---
- * @access private
- * ---
- * @since 1.2.0
- * ---
- * @param {string} $string - string to check
- * @param {string} $needle - substring to check
- * ---
- * @return {bool}
- */
-
+/// Check whether `$string` stars with `$needle`.
+/// @since 1.2.0
+/// @param {String} $string - string to check
+/// @param {String} $needle - substring to check
+/// @return {Bool}
 @function _ss-str-starts-with($string, $needle) {
   @return str-slice($string, 1, str-length($needle)) == $needle;
 }

data/stylesheets/private/_str-trim.scss

@@ -1,15 +1,7 @@
-/*
- * Remove all trailing and leading whitespaces from $string
- * ---
- * @access private
- * ---
- * @since 1.2.0
- * ---
- * @param {string} $string - string
- * ---
- * @return {string}
- */
-
+/// Remove all trailing and leading whitespaces from `$string`.
+/// @since 1.2.0
+/// @param {String} $string - string
+/// @return {String}
 @function _ss-str-trim($string) {
   $start: 1;
   $end: str-length($string);
@@ -28,4 +20,4 @@
   }
 
   @return str-slice($string, $start, $end);
-}
+}

data/stylesheets/private/_str-ucfirst.scss

@@ -1,15 +1,7 @@
-/* 
- * Capitalize first letter from $string
- * ---
- * @access private
- * ---
- * @since 1.2.0
- * ---
- * @param {string} $string - string for capitalization
- * ---
- * @return {string}
- */
-
+/// Capitalize first letter from `$string`.
+/// @since 1.2.0
+/// @param {String} $string - string for capitalization
+/// @return {String}
 @function _ss-str-ucfirst($string) {
   @return to-upper-case(str-slice($string, 1, 1)) + str-slice($string, 2);
-}
+}

data/stylesheets/private/_str-word-count.scss

@@ -1,17 +1,9 @@
-/*
- * Count number of words in $string
- * ---
- * @access private
- * ---
- * @since 1.2.0
- * ---
- * @param {string} $string - string to check
- * ---
- * @return {string|false}
- */
-
+/// Count number of words in `$string`.
+/// @since 1.2.0
+/// @param {String} $string - string to check
+/// @return {String}
 @function _ss-str-word-count($string) {
-    @if $string == '' {
+    @if $string == "" {
         @return 0;
     }
 
@@ -28,4 +20,4 @@
     }
 
     @return length(append($words, $string));
-}
+}

data/stylesheets/private/_stringify.scss

@@ -1,26 +1,17 @@
-/*
- * Cast anything to string
- * ---
- * @access private
- * ---
- * @since 1.2.0
- * ---
- * @param {literal} $literal: number to cast to string
- * ---
- * @return {string}
- */
-
+/// Cast `$literal` to string.
+/// @since 1.2.0
+/// @param {*} `$literal` - number to cast to string
+/// @return {String}
 @function _ss-stringify($literal) {
-    $result: "";
+  $result: "";
 
-    @if length($literal) == 1 {
-        $result: $literal + unquote("");
-    } @else {
-        @each $item in $literal {
-            $result: $result + stringify($item);
-        }
+  @if length($literal) == 1 {
+    $result: $literal + unquote("");
+  } @else {
+    @each $item in $literal {
+      $result: $result + stringify($item);
     }
+  }
 
-    @return quote($result);
-    
-}
+  @return quote($result);
+}

data/stylesheets/public/_all.scss

@@ -1,6 +1,7 @@
 //* ----------------------------------------------------- */
-// Public files for use in your project 
+// Public files for use in your project
 //* ----------------------------------------------------- */
+
 @import "char-at";
 @import "levenshtein";
 @import "str-count";
@@ -20,4 +21,4 @@
 @import "str-trim";
 @import "str-ucfirst";
 @import "str-word-count";
-@import "stringify";
+@import "stringify";