SassyStrings 1.1.3 → 1.1.4

data/CHANGELOG.md

@@ -1,5 +1,6 @@
 # Changelog
 
+* `1.1.4`: improved `str-replace` and added SassDoc compliant comments
 * `1.1.3`: bumped Sass dependency to 3.4.x
 * `1.1.2`: fixed an error when using private functions
 * `1.1.1`: fixed an error when using private functions

data/README.md

@@ -5,9 +5,9 @@ Here is a [Compass Extension](http://compass-style.org/) providing you all funct
 ## What's in there?
 
 * `char-at($string, $index)`: returns the character from `$string` at index `$index`
-* `levenshtein($a, $b)`: returns the Levenshtein distance betwee `$a` and `$b`
+* `levenshtein($a, $b)`: returns the Levenshtein distance between `$a` and `$b`
 * `str-count($string, $needle)`: counts number of occurrences of `$needle` in `$string`
-* `str-ends-with($string, $needle)`: returns wether `$string` ends with `$needle`
+* `str-ends-with($string, $needle)`: returns whether `$string` ends with `$needle`
 * `str-explode($string, $separator)`: explodes `$string` on `$separator` occurrences
 * `str-implode($list)`: implodes `$list` into a string
 * `str-last-index($string, $needle)`: returns last index of `$needle` in `$string`
@@ -15,12 +15,12 @@ Here is a [Compass Extension](http://compass-style.org/) providing you all funct
 * `str-pad($string, $length, $pad: " ", $direction: left)`: pads `$string` with `$pad` to match `$length` starting from `$direction`
 * `str-printf($string, $elements...)`: replaces occurrences of `%s` in `$string` by elements from `$elements`
 * `str-repeat($string, $times)`: repeats `$string` `$times` times
-* `str-replace($string, $old, $new: "", $case-sensitive: true)`: replaces `$old` by `$new` in `$string` respecting `$case-sensitive`
+* `str-replace($string, $old, $new: "")`: replaces `$old` by `$new` in `$string` respecting `$case-sensitive`
 * `str-reverse($string)`: reverses string
 * `str-rot($string, $rot: 13)`: rotates letters in `$string` of `$rot` position in alphabet
 * `str-shuffle($string)`: shuffles letters in string
 * `str-split($string)`: splits `$string` into a list of characters
-* `str-starts-width($string, $needle)`: returns wether `$string` starts with `$needle`
+* `str-starts-with($string, $needle)`: returns whether `$string` starts with `$needle`
 * `str-trim($string)`: removes white spaces before and after `$string`
 * `str-ucfirst($string)`: turns first letter of `$string` into upper case
 * `str-word-count($string)`: counts number of words in `$string`

data/lib/SassyStrings.rb

@@ -4,8 +4,8 @@ extension_path = File.expand_path(File.join(File.dirname(__FILE__), ".."))
 Compass::Frameworks.register("SassyStrings", :path => "#{File.dirname(__FILE__)}/..")
 
 module SassyStrings
-  VERSION = "1.1.3"
-  DATE = "2014-11-27"
+  VERSION = "1.1.4"
+  DATE = "2014-12-31"
 end
 
 # Sassy String Functions

data/stylesheets/private/_all.scss

@@ -1,7 +1,7 @@
 //* ----------------------------------------------------- */
 // Private files
-// Use at your own risk
 //* ----------------------------------------------------- */
+
 @import "char-at";
 @import "levenshtein";
 @import "str-count";
@@ -21,4 +21,4 @@
 @import "str-trim";
 @import "str-ucfirst";
 @import "str-word-count";
-@import "stringify";
+@import "stringify";

data/stylesheets/private/_char-at.scss

@@ -1,16 +1,8 @@
-/*
- * Return character from $string at $index
- * ---
- * @access private
- * ---
- * @since 1.2.0
- * ---
- * @param {string} $string - string to check
- * @param {string} $index  - index to inspect
- * ---
- * @return {string}
- */
-
+/// Return character from `$string` at `$index`.
+/// @since 1.2.0
+/// @param {String} $string - string to check
+/// @param {String} $index  - index to inspect
+/// @return {String}
 @function _ss-char-at($string, $index) {
-    @return str-slice($string, $index, $index);
-}
+  @return str-slice($string, $index, $index);
+}

data/stylesheets/private/_levenshtein.scss

@@ -1,105 +1,84 @@
-/*
- * Calculating Levenshtein distance between two strings
- * ---
- * @access private
- * ---
- * @since 1.2.0
- * ---
- * @param {string} $a - first string
- * @param {string} $b - second string
- * ---
- * @return {number}
- */
+/// Calculating Levenshtein distance between strings `$a` and `$b`.
+/// @since 1.2.0
+/// @param {String} $a - first string
+/// @param {String} $b - second string
+/// @return {Number}
 @function _ss-levenshtein($a, $b) {
-    $a: to-lower-case($a);
-    $b: to-lower-case($b);
+  $a: to-lower-case($a);
+  $b: to-lower-case($b);
 
-    $n: str-length($a);
-    $m: str-length($b);
+  $n: str-length($a);
+  $m: str-length($b);
 
-    $matrix: _ss-matrix($n + 1, $m + 1);
-    $cost: _ss-matrix($n, $m);
+  $matrix: _ss-matrix($n + 1, $m + 1);
+  $cost: _ss-matrix($n, $m);
 
-    @if $a == $b { @return 0; }
-    @if $n == 0  { @return $m; }
-    @if $m == 0  { @return $n; }
+  @if $a == $b { @return 0; }
+  @if $n == 0  { @return $m; }
+  @if $m == 0  { @return $n; }
 
-    @for $i from 0 through $n  {
-        @for $j from 0 through $m  {
-            $v: if($i == 0, $j, if($j == 0, $i, 0));
-            @if $v != 0 {
-                $matrix: _ss-set-matrix($matrix, $i + 1, $j + 1, $v);
-            }
-            @if $i != 0 and $j != 0 {
-                $v: if(str-slice($a, $i, $i) == str-slice($b, $j, $j), 0, 1);
-                @if $v != 0 {
-                    $cost: _ss-set-matrix($cost, $i, $j, $v);
-                }
-            }
+  @for $i from 0 through $n  {
+    @for $j from 0 through $m  {
+      $v: if($i == 0, $j, if($j == 0, $i, 0));
+      @if $v != 0 {
+        $matrix: _ss-set-matrix($matrix, $i + 1, $j + 1, $v);
+      }
+      @if $i != 0 and $j != 0 {
+        $v: if(str-slice($a, $i, $i) == str-slice($b, $j, $j), 0, 1);
+        @if $v != 0 {
+          $cost: _ss-set-matrix($cost, $i, $j, $v);
         }
+      }
     }
+  }
 
-    @for $i from 2 through length($matrix) {
-        @for $j from 2 through length(nth($matrix, $i)) {
-            $matrix: _ss-set-matrix($matrix, $i, $j, min(_ss-e($matrix, $i - 1, $j) + 1, _ss-e($matrix, $i, $j - 1) + 1, _ss-e($matrix, $i - 1, $j - 1) + _ss-e($cost, $i - 1, $j - 1)));
-        }
+  @for $i from 2 through length($matrix) {
+    @for $j from 2 through length(nth($matrix, $i)) {
+      $matrix: _ss-set-matrix($matrix, $i, $j, min(_ss-e($matrix, $i - 1, $j) + 1, _ss-e($matrix, $i, $j - 1) + 1, _ss-e($matrix, $i - 1, $j - 1) + _ss-e($cost, $i - 1, $j - 1)));
     }
+  }
 
-    @return _ss-e($matrix, length($matrix), length(nth($matrix, 1)));
+  @return _ss-e($matrix, length($matrix), length(nth($matrix, 1)));
 }
 
-/*
- * Helper to target an element in a matrix
- * ---
- * @access private
- * ---
- * @param {number} $m - matrix
- * @param {number} $x - x coord
- * @param {number} $y - y coord
- * ---
- * @return {number}
- */
-
+/// Helper to target an element in a matrix
+/// @access private
+/// @param {Number} $m - matrix
+/// @param {Number} $x - x coord
+/// @param {Number} $y - y coord
+/// @return {Number}
 @function _ss-e($m, $x, $y) {
-    @return nth(nth($m, $x), $y);
+  @return nth(nth($m, $x), $y);
 }
 
-/*
- * Helper instanciation a matrix of $x by $y
- * ---
- * @access private
- * ---
- * @param {number} $x - number of cols
- * @param {number} $y - number of lines
- * ---
- * @return {list}
- */
-
+/// Helper instanciation a matrix of $x by $y
+/// @access private
+/// @param {Number} $x - number of cols
+/// @param {Number} $y - number of lines
+/// @return {List}
 @function _ss-matrix($x, $y) {
-    $matrix: ();
-    @for $i from 1 through $x {
-        $tmp: ();
-        @for $y from 1 through $y {
-            $tmp: append($tmp, 0)
-        }
-        $matrix: append($matrix, $tmp);
+  $matrix: ();
+
+  @for $i from 1 through $x {
+    $tmp: ();
+
+    @for $y from 1 through $y {
+      $tmp: append($tmp, 0)
     }
-    @return $matrix;
-}
 
-/*
- * Helper assigning $value at $matrix[$x, $y]
- * ---
- * @access private
- * ---
- * @param {number} $matrix - matrix to update
- * @param {number} $x      - x coord
- * @param {number} $y      - y coord
- * @param {number} $value  - value to assign at $matrix[$x, $y]
- * ---
- * @return [list]
- */
+    $matrix: append($matrix, $tmp);
+  }
 
+  @return $matrix;
+}
+
+/// Helper assigning $value at $matrix[$x, $y]
+/// @access private
+/// @param {Number} $matrix - matrix to update
+/// @param {Number} $x      - x coord
+/// @param {Number} $y      - y coord
+/// @param {Number} $value  - value to assign at $matrix[$x, $y]
+/// @return {List}
 @function _ss-set-matrix($matrix, $x, $y, $value) {
     @return set-nth($matrix, $x, set-nth(nth($matrix, $x), $y, $value));
-}
+}

data/stylesheets/private/_str-count.scss

@@ -1,27 +1,19 @@
-/*
- * Count the number of occurrences of $needle in $string
- * ---
- * @access private
- * ---
- * @since 1.2.0
- * ---
- * @param {string} $string - string
- * @param {string} $needle - substring to count in $string
- * ---
- * @return {number}
- */
-
+/// Count the number of occurrences of `$needle` in `$string`.
+/// @since 1.2.0
+/// @param {String} $string - string
+/// @param {String} $needle - substring to count in `$string`
+/// @return {Number}
 @function _ss-str-count($string, $needle) {
-    $index: str-index($string, $needle);
-    $result: if($index, 1, 0);
+  $index: str-index($string, $needle);
+  $result: if($index, 1, 0);
 
-    @if $index {
-        @for $i from $index + str-length($needle) through str-length($string) {
-            @if str-slice($string, $i, $i + str-length($needle) - 1) == $needle {
-                $result: $result + 1;
-            }
-        }
+  @if $index {
+    @for $i from $index + str-length($needle) through str-length($string) {
+      @if str-slice($string, $i, $i + str-length($needle) - 1) == $needle {
+        $result: $result + 1;
+      }
     }
+  }
 
-    @return $result;
-}
+  @return $result;
+}

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

@@ -1,16 +1,8 @@
-/*
- * Check whether $string ends 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` ends with `$needle`.
+/// @since 1.2.0
+/// @param {String} $string - string to check
+/// @param {String} $needle - substring to check
+/// @return {Bool}
 @function _ss-str-ends-with($string, $needle) {
-    @return str-slice($string, -1 * str-length($needle)) == $needle;
+  @return str-slice($string, -1 * str-length($needle)) == $needle;
 }

data/stylesheets/private/_str-explode.scss

@@ -1,41 +1,34 @@
-/*
- * Split $string into several parts using $delimiter
- * ---
- * @access private
- * ---
- * @since 1.2.0
- * ---
- * @param {string} $string    - string to split
- * @param {string} $delimiter - string to use as a delimiter to split $string
- * ---
- * @return {list}
- */
+/// Split `$string` into several parts using `$delimiter`.
+/// @since 1.2.0
+/// @param {String} $string    - string to split
+/// @param {String} $delimiter ('') - string to use as a delimiter to split `$string`
+/// @return {List}
+@function _ss-str-explode($string, $delimiter: "") {
+  $result: ();
+  $length: str-length($string);
 
-@function _ss-str-explode($string, $delimiter: '') {
-    $result: ();
-    $length: str-length($string);
-
-    @if str-length($delimiter) == 0 {
-        @for $i from 1 through $length {
-            $result: append($result, str-slice($string, $i, $i));
-        }
-        @return $result;
+  @if str-length($delimiter) == 0 {
+    @for $i from 1 through $length {
+      $result: append($result, str-slice($string, $i, $i));
     }
 
-    $running: true;
-    $remaining: $string;
+    @return $result;
+  }
+
+  $running: true;
+  $remaining: $string;
+
+  @while $running {
+    $index: str-index($remaining, $delimiter);
 
-    @while $running {
-        $index: str-index($remaining, $delimiter);
-        @if $index {
-            $slice: str-slice($remaining, 1, $index - 1);
-            $result: append($result, $slice);
-            $remaining: str-slice($remaining, $index + str-length($delimiter));
-        }
-        @else {
-            $running: false;
-        }
+    @if $index {
+      $slice: str-slice($remaining, 1, $index - 1);
+      $result: append($result, $slice);
+      $remaining: str-slice($remaining, $index + str-length($delimiter));
+    } @else {
+      $running: false;
     }
+  }
 
-    @return append($result, $remaining);
-}
+  @return append($result, $remaining);
+}

data/stylesheets/private/_str-implode.scss

@@ -1,21 +1,13 @@
-/*
- * Implode $list into a string
- * ---
- * @access private
- * ---
- * @since 1.2.0
- * ---
- * @param {list} $list - list to convert to string
- * ---
- * @return {string}
- */
-
+/// Implode `$list` into a string.
+/// @since 1.2.0
+/// @param {List} $list - list to convert to string
+/// @return {String}
 @function _ss-str-implode($list) {
-    $result: "";
+  $result: "";
 
-    @each $item in $list {
-        $result: $result + if(length($item) > 1, str-implode($item), $item);
-    }
+  @each $item in $list {
+    $result: $result + if(length($item) > 1, str-implode($item), $item);
+  }
 
-    @return $result;
-}
+  @return $result;
+}

data/stylesheets/private/_str-last-index.scss

@@ -1,16 +1,8 @@
-/* 
- * Return last index of $needle in $string
- * ---
- * @access private
- * ---
- * @since 1.2.0
- * ---
- * @param {string} $string - string to search in
- * @param {string} $needle - substring to search for
- * ---
- * @return {number}
- */
-
+/// Return last index of `$needle` in `$string`.
+/// @since 1.2.0
+/// @param {String} $string - string to search in
+/// @param {String} $needle - substring to search for
+/// @return {Number}
 @function _ss-str-last-index($string, $needle) {
   $index: str-index($string, $needle);
   $result: $index;
@@ -24,4 +16,4 @@
   }
 
   @return $result;
-}
+}