SassyStrings 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3899887f5222edd4ba1eecc70d5f9050abce8de9
-  data.tar.gz: e02a8b4448c9c00d2272a1b1a1d399d9bf4e1f6e
+  metadata.gz: d70bcfa2579e805f82da0912eef6f090541410bf
+  data.tar.gz: 1dc25991030d97b6a074736f6c8586be02c6e6e2
 SHA512:
-  metadata.gz: be9b497e564554997e0d12d51bc54b6bc36610bdaf2cebc1a151d0563dcfc643a572b15483bafc10c2000f6324572f09c691fa6a5ea805de1c58f4c3bcf81992
-  data.tar.gz: a92dba77ae9cedacc0234a429723f8ac819c1f225d76666196fa73e008c140f306bb844bc651ed389e6ed6af6fe0c87a42030cc92d2a4d4c53f7511c410d897d
+  metadata.gz: 57479ce6911600c434b4ae2d69e8e5d2e19e110885d77156b2980d346990392f2cd0c4605ddef84d1c6949c6653e959c27ce7dcd1545483ca48484e0f1458473
+  data.tar.gz: fe84136981c67e4782df41f6d19eaa51f7ab6765aced5c0d10643eef55fb81bd316519011f1c879860d5018da734009f07f59e11deff92b6175f1447c740202c

data/CHANGELOG.md

@@ -1,4 +1,5 @@
 # Changelog
 
+* `1.1.0`: dissociated error checking from function logic, and added some missing imports
 * `1.0.1`: fixed a lot of tiny bugs ([#8](https://github.com/HugoGiraudel/SassyStrings/pull/8))
 * `1.0.0`: initial commit

data/README.md

@@ -47,3 +47,8 @@ Some functions depend on other functions. If you include functions individually,
 ## Credits
 
 Huge thanks to [Marc Mintel](http://twitter.com/marcmintel) for his help.
+
+## Advanced usage
+
+If you experience naming conflicts or want to add your own error handling and dependency checker feel free to use the functions in `stylesheets/private`.
+These functions do not add any kind of error handling so use them at your own risk!

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.0.1"
-  DATE = "2014-02-16"
+  VERSION = "1.1.0"
+  DATE = "2014-09-28"
 end
 
 # Sassy String Functions

data/stylesheets/_SassyStrings.scss

@@ -4,23 +4,5 @@
 // Repository: https://github.com/HugoGiraudel/SassyStrings/
 // -------------------------------------------------------------------------------
 
-@import "functions/char-at";
-@import "functions/levenshtein";
-@import "functions/str-count";
-@import "functions/str-ends-with";
-@import "functions/str-explode";
-@import "functions/str-implode";
-@import "functions/str-last-index";
-@import "functions/str-lcfirst";
-@import "functions/str-pad";
-@import "functions/str-printf";
-@import "functions/str-repeat";
-@import "functions/str-replace";
-@import "functions/str-reverse";
-@import "functions/str-rot";
-@import "functions/str-shuffle";
-@import "functions/str-starts-with";
-@import "functions/str-trim";
-@import "functions/str-ucfirst";
-@import "functions/str-word-count";
-@import "functions/stringify";
+@import 'private/all';
+@import 'public/all';

data/stylesheets/private/_all.scss

@@ -0,0 +1,24 @@
+//* ----------------------------------------------------- */
+// Private files
+// Use at your own risk
+//* ----------------------------------------------------- */
+@import "char-at";
+@import "levenshtein";
+@import "str-count";
+@import "str-ends-with";
+@import "str-explode";
+@import "str-implode";
+@import "str-last-index";
+@import "str-lcfirst";
+@import "str-pad";
+@import "str-printf";
+@import "str-repeat";
+@import "str-replace";
+@import "str-reverse";
+@import "str-rot";
+@import "str-shuffle";
+@import "str-starts-with";
+@import "str-trim";
+@import "str-ucfirst";
+@import "str-word-count";
+@import "stringify";

data/stylesheets/private/_char-at.scss

@@ -0,0 +1,16 @@
+/*
+ * 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}
+ */
+
+@function _ss-char-at($string, $index) {
+    @return str-slice($string, $index, $index);
+}

data/stylesheets/private/_levenshtein.scss

@@ -0,0 +1,105 @@
+/*
+ * Calculating Levenshtein distance between two strings
+ * ---
+ * @access private
+ * ---
+ * @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);
+
+    $n: str-length($a);
+    $m: str-length($b);
+
+    $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; }
+
+    @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)));
+        }
+    }
+
+    @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}
+ */
+
+@function _ss-e($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}
+ */
+
+@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);
+    }
+    @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

@@ -0,0 +1,27 @@
+/*
+ * 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}
+ */
+
+@function _ss-str-count($string, $needle) {
+    $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;
+            }
+        }
+    }
+
+    @return $result;
+}

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

@@ -0,0 +1,16 @@
+/*
+ * 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}
+ */
+
+@function _ss-str-ends-with($string, $needle) {
+    @return str-slice($string, -1 * str-length($needle)) == $needle;
+}

data/stylesheets/private/_str-explode.scss

@@ -0,0 +1,41 @@
+/*
+ * 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}
+ */
+
+@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;
+    }
+
+    $running: true;
+    $remaining: $string;
+
+    @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;
+        }
+    }
+
+    @return append($result, $remaining);
+}

data/stylesheets/private/_str-implode.scss

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

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

@@ -0,0 +1,27 @@
+/* 
+ * 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}
+ */
+
+@function _ss-str-last-index($string, $needle) {
+  $index: str-index($string, $needle);
+  $result: $index;
+
+  @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: $i;
+      }
+    }
+  }
+
+  @return $result;
+}

data/stylesheets/private/_str-lcfirst.scss

@@ -0,0 +1,15 @@
+/*
+ * Lower case first character of $string
+ * ---
+ * @access private
+ * ---
+ * @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

@@ -0,0 +1,36 @@
+/*
+ * 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}
+ */
+
+@function _ss-str-pad($string, $length, $pad: " ", $direction: left) {
+  $direction: if(index(left right, $direction), $direction, left);
+  $new-string: $string;
+  $index: 1;
+
+  @if $length > str-length($string) {
+    @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 {
+        $new-string: $new-string + $pad;
+      }
+    }
+  }
+
+  @return $new-string;
+}

data/stylesheets/private/_str-printf.scss

@@ -0,0 +1,29 @@
+/*
+ * 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}
+ */
+
+@function _ss-str-printf($string, $elements...) {
+  $breaker: '%s'; 
+  $result: $string;
+
+  @for $i from 1 through length($elements) {
+    $index: str-index($result, $breaker);
+    @if $index {
+      $result: str-slice($result, 1, $index - 1) + stringify(nth($elements, $i)) + str-slice($result, $index + str-length($breaker));
+    }
+    @else {
+      @return $result;
+    }
+  }
+
+  @return $result;
+}