SassyLists 0.4.9 → 1.0.0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+* `1.0.0`: moving code base to Sass 3.3 + adding a Grunt workflow
+    * adding `explode`
+    * making use of `list-separator()` and `set-nth()`
+    * updating `sort()` to make it able to sort strings
+    * removing all notion of recursion for sake of simplicity
+    * making `count-values()` return a map
+    * minor fixes and improvements
+    * improving overall performances
 * `0.4.9`: removing `compact()` alias for `purge()` (ref [#23](https://github.com/Team-Sass/SassyLists/issues/23))
 * `0.4.8`: adding `shuffle()`
 * `0.4.7`: dramatically improving `sort()` performances and removing all its dependencies

data/lib/SassyLists.rb

@@ -5,8 +5,8 @@ Compass::Frameworks.register('SassyLists', :path => extension_path)
 #  Version is a number. If a version contains alphas, it will be created as a prerelease version
 #  Date is in the form of YYYY-MM-DD
 module SassyLists
-  VERSION = "0.4.9"
-  DATE = "2014-01-20"
+  VERSION = "1.0.0"
+  DATE = "2014-03-09"
 end
 
 module Sass::Script::Functions

data/stylesheets/SassyLists/_chunk.scss

@@ -2,46 +2,41 @@
 // -------------------------------------------------------------------------------
 // @documentation http://sassylists.com/documentation/#chunk
 // -------------------------------------------------------------------------------
-// @example chunk(a b c d e, 2) => a b, c d, e
-// @example chunk(a b c d e, 3) => a b c, d e
-// -------------------------------------------------------------------------------
 // @param $list [List] : list
 // @param $size [Number] : length of lists
 // -------------------------------------------------------------------------------
-// @raise [Error] if $list is empty
+// @raise [Error] if $size is not a number
 // -------------------------------------------------------------------------------
 // @return [List] | false
 
 @function chunk($list, $size) {
-    @if $list == () {
-        @warn "Trying to chunk empty list in `chunk`.";
-        @return false;
-    }
-
-    @if $size >= length($list) {
-        @return $list;
+  @if type-of($size) != "number" {
+    @warn "#{$size} is not a number for `chunk`.";
+    @return false;
+  }
+
+  @if $size >= length($list) {
+    @return $list;
+  }
+
+  $index: 1;
+  $result: ();
+  $length: length($list);
+  $end: ceil($length / $size);
+
+  @for $i from 1 through $end {
+    $tmp: ();
+
+    @for $j from 1 through $size {
+      @if $index <= $length {
+        $is-orphan: $length % $size == 1 and $j == 1;
+        $tmp: if($is-orphan, nth($list, $index), append($tmp, nth($list, $index)));
+      }
+      $index: $index + 1;
     }
 
-    $index: 1;
-    $result: ();
-
-    @for $i from 1 through ceil(length($list) / $size) {
-        $tmp: ();
-
-        @for $j from 1 through $size {
-
-            @if $index <= length($list) {
-
-                $is-orphan: length($list) % $size == 1 and $j == 1;
-                $tmp: if($is-orphan, nth($list, $index), append($tmp, nth($list, $index)));
-
-            }
-      
-            $index: $index + 1;
-        }
-
-        $result: append($result, $tmp);
-    }
+    $result: append($result, $tmp);
+  }
 
-    @return $result;
+  @return $result;
 }

data/stylesheets/SassyLists/_contain.scss

@@ -4,19 +4,16 @@
 // -------------------------------------------------------------------------------
 // @alias `include()`
 // -------------------------------------------------------------------------------
-// @example contain(a b c, a) => true
-// @example contain(a b c, z) => false
-// -------------------------------------------------------------------------------
 // @param $list [List] : list
 // @param $value [Literal] : value to look for
 // -------------------------------------------------------------------------------
 // @return [Boolean]
 
 @function contain($list, $value) {
-    @return not not index($list, $value);
+  @return not not index($list, $value);
 }
 
 // Alias
 @function include($list, $value) {
-    @return contain($list, $value);
+  @return contain($list, $value);
 }

data/stylesheets/SassyLists/_count-values.scss

@@ -2,31 +2,18 @@
 // -------------------------------------------------------------------------------
 // @documentation http://sassylists.com/documentation/#count-values
 // -------------------------------------------------------------------------------
-// @dependence `replace-nth()`
-// -------------------------------------------------------------------------------
-// @example count-values(a b c d e)       => a 1, b 1, c 1, d 1, e 1
-// @example count-values(a b c a d b a e) => a 3, b 2, c 1, d 1, e 1
-// -------------------------------------------------------------------------------
 // @param $list [List] : list
 // -------------------------------------------------------------------------------
-// @return [List]
+// @return [Map]
 
 @function count-values($list) {
-    $keys: ();
-    $counts: ();
-
-    @each $item in $list {
-        $index: index($keys, $item);
-
-        @if not $index {
-            $keys: append($keys, $item);
-            $counts: append($counts, 1);
-        }
+  $map: ();
 
-        @else {
-            $counts: replace-nth($counts, $index, nth($counts, $index) + 1);
-        }
-    }
+  @each $item in $list {
+    $index: map-get($map, $item);
+    $value: if($index, $index + 1, 1);
+    $map: map-merge($map, ($item: $value));
+  }
 
-    @return zip($keys, $counts);
-}
+  @return $map;
+}

data/stylesheets/SassyLists/_debug.scss

@@ -2,9 +2,6 @@
 // -------------------------------------------------------------------------------
 // @documentation http://sassylists.com/documentation/#debug
 // -------------------------------------------------------------------------------
-// @example debug(a b c d e)   => [ a, b, c, d, e ]
-// @example debug(a b (c d e)) => [ a, b, [ c, d, e ] ]
-// -------------------------------------------------------------------------------
 // @param $list [List] : list
 // @param $pre [Boolean] : enable/disable variables type and proper indentation
 // @param $level [Number] : internal variable for recursivity
@@ -12,64 +9,65 @@
 // @return [String]
 
 @function debug($list, $pre: false, $level: 1) {
-    @if length($list) == 0 {
-        @return "( )";
-    }
-  
-    @if length($list) == 1 {
-        @return if($pre,  "(" + type-of($list) + ") ", "") + $list;
+  @if length($list) == 0 {
+    @return "( )";
+  }
+
+  @if length($list) == 1 {
+    @return if($pre,  "(" + type-of($list) + ") ", "") + $list;
+  }
+
+  $tab: "    ";
+  $indent: "";
+  $break: if($pre, "\A ", "");
+  $length: length($list);
+
+  @for $i from 1 to $level {
+    $indent: $indent + $tab;
+  }
+
+  $result: "[" + $break;
+
+  @for $i from 1 through $length {
+    $item: nth($list, $i);
+    $result: $result + if($pre, $indent + $tab, " ");
+
+    @if length($item) > 1 {
+      $result: $result
+        + if($pre, "(list: " + length($item) + ") ", "")
+        + debug($item, $pre, $level + 1);
     }
 
-    $tab: "    ";
-    $indent: "";
-    $break: if($pre, "\A ", "");
+    @else {
+      @if $pre {
+        $result: $result + "(" + type-of($item) + ") ";
+      }
+
+      @if length($item) == 0 {
+        $result: $result + "( )";
+      }
 
-    @for $i from 1 to $level {
-        $indent: $indent + $tab;
+      @else if type-of($item) == "string" {
+        $result: $result + quote($item);
+      }
+
+      @else if $item == null {
+        $result: $result + "null";
+      }
+
+      @else {
+        $result: $result + $item;
+      }
     }
 
-    $result: "[" + $break;
-
-    @for $i from 1 through length($list) {
-        $item: nth($list, $i);
-        $result: $result + if($pre, $indent + $tab, " ");
-
-        @if length($item) > 1 {
-            $result: $result 
-                + if($pre, "(list: " + length($item) + ") ", "") 
-                + debug($item, $pre, $level + 1);
-        }
-
-        @else {
-            @if $pre {
-                $result: $result + "(" + type-of($item) + ") ";
-            }
-      
-            @if length($item) == 0 {
-                $result: $result + "( )";
-            }
-      
-            @else if type-of($item) == string {
-                $result: $result + quote($item);
-            }
-      
-            @else if $item == null {
-                $result: $result + "null";
-            }
-      
-            @else {
-                $result: $result + $item;
-            }
-        }
-    
-        @if $i != length($list) {
-            $result: $result + "," + $break;
-        }
+    @if $i != $length {
+      $result: $result + "," + $break;
     }
+  }
 
-    $result: $result + $break + if($pre, if($level > 1, $indent, ""), " ") + "]";
+  $result: $result + $break + if($pre, if($level > 1, $indent, ""), " ") + "]";
 
-    @return quote($result);
+  @return quote($result);
 }
 
 // Mixin displaying clean debug
@@ -77,20 +75,20 @@
 // @param $list [List] : list
 
 @mixin debug($list) {
-    body:before {
-        content: debug($list, true)               !important;
+  body:before {
+    content: debug($list, true)               !important;
 
-        display: block                            !important;
-        margin: 1em                               !important;
-        padding: .5em                             !important; 
+    display: block                            !important;
+    margin: 1em                               !important;
+    padding: .5em                             !important; 
 
-        background: #EFEFEF                       !important;
-        border: 1px solid #DDD                    !important;
-        border-radius: .2em                       !important;
+    background: #EFEFEF                       !important;
+    border: 1px solid #DDD                    !important;
+    border-radius: .2em                       !important;
 
-        color: #333                               !important;
-        font: .75em/1.5 "Courier New", monospace  !important;
-        text-shadow: 0 1px white                  !important;
-        white-space: pre-wrap                     !important;
-    }
+    color: #333                               !important;
+    font: .75em/1.5 "Courier New", monospace  !important;
+    text-shadow: 0 1px white                  !important;
+    white-space: pre-wrap                     !important;
+  }
 }

data/stylesheets/SassyLists/_explode.scss

@@ -0,0 +1,49 @@
+// Explode $string into a list using $break as a breaker
+// -------------------------------------------------------------------------------
+// @documentation http://sassylists.com/documentation/#explode
+// -------------------------------------------------------------------------------
+// @param $string [String] : string to explode
+// @param $separator [String] : string to use as the breaker
+// -------------------------------------------------------------------------------
+// @raise [Error] if either argument is not a string
+// -------------------------------------------------------------------------------
+// @return [List]
+
+@function explode($string, $delimiter: '') {
+  @if type-of($string) != "string" {
+    @warn "`explode` function expecting a string; #{type-of($string)} given.";
+    @return false;
+  }
+
+  @if type-of($delimiter) != "string" {
+    @warn "`explode` function expecting a string; #{type-of($delimiter)} given.";
+    @return false;
+  }
+
+  $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 not $index or $index == 0 {
+      $running: false;
+    }
+    @else {
+      $slice: str-slice($remaining, 1, $index - 1);
+      $result: append($result, $slice);
+      $remaining: str-slice($remaining, $index + str-length($delimiter));
+    }
+  }
+
+  @return append($result, $remaining);
+}

data/stylesheets/SassyLists/_first.scss

@@ -4,17 +4,22 @@
 // -------------------------------------------------------------------------------
 // @alias `head()`
 // -------------------------------------------------------------------------------
-// @example first(a b c) => a
-// -------------------------------------------------------------------------------
 // @param $list [List] : list
 // -------------------------------------------------------------------------------
-// @return [Literal]
+// @raise [Error] if either $list is empty
+// -------------------------------------------------------------------------------
+// @return [Literal] | false
 
 @function first($list) {
-    @return nth($list, 1);
+  @if length($list) == 0 {
+    @warn "Cannot find first item of empty list.";
+    @return false;
+  }
+
+  @return nth($list, 1);
 }
 
 // Alias
 @function head($list) {
-    @return first($list);
+  @return first($list);
 }

data/stylesheets/SassyLists/_flatten.scss

@@ -4,28 +4,31 @@
 // -------------------------------------------------------------------------------
 // @alias `unfold()`
 // -------------------------------------------------------------------------------
-// @example flatten(a b (c d (e f))) => a b c d e f
-// -------------------------------------------------------------------------------
 // @param $list [List] : list
 // -------------------------------------------------------------------------------
 // @return [List]
 
 @function flatten($list) {
-    $result: ();
+  $result: ();
+
+  @if length($list) == 1 {
+    @return $list;
+  }
 
-    @each $item in $list {
-        @if length($item) > 1 {
-            @each $i in flatten($item) {
-                $result: append($result, $i);
-            }
-        }
+  @each $item in $list {
+    @if length($item) > 1 {
+      $flatten: flatten($item);
+      @each $i in $flatten {
+        $result: append($result, $i, list-separator($list));
+      }
+    }
 
-        @else {
-            $result: append($result, $item);
-        }
+    @else {
+      $result: append($result, $item, list-separator($list));
     }
+  }
 
-    @return $result;
+  @return $result;
 }
 
 // Alias

data/stylesheets/SassyLists/_insert-nth.scss

@@ -2,11 +2,6 @@
 // -------------------------------------------------------------------------------
 // @documentation http://sassylists.com/documentation/#insert-nth
 // -------------------------------------------------------------------------------
-// @example insert-nth(a b c,  2, z) => a z d c
-// @example insert-nth(a b c,  0, z) => error
-// @example insert-nth(a b c, -1, z) => error
-// @example insert-nth(a b c, 10, z) => a b c z
-// -------------------------------------------------------------------------------
 // @param $list [List] : list
 // @param $index [Number] : index to add
 // @param $value [Literal] : value to add
@@ -18,31 +13,33 @@
 // @return [List] | false
 
 @function insert-nth($list, $index, $value) {
-    @if type-of($index) != number {
-        @warn "List index #{$index} is not a number for `insert-nth`.";
-        @return false;
-    }
+  $length: length($list);
 
-    @if $index < 1 {
-        @warn "List index #{$index} must be a non-zero integer for `insert-nth`";
-        @return false;
-    }
+  @if type-of($index) != number {
+    @warn "List index #{$index} is not a number for `insert-nth`.";
+    @return false;
+  }
 
-    @if $index > length($list) {
-        @return append($list, $value);
-    }
+  @if $index < 1 {
+    @warn "List index #{$index} must be a non-zero integer for `insert-nth`";
+    @return false;
+  }
 
-    $result: ();
+  @if $index > $length {
+    @return append($list, $value, list-separator($list));
+  }
 
-    @for $i from 1 through length($list) {
-        @if $i == $index {
-            @if $value and $value != "" and $value != () {
-                $result: append($result, $value);
-            }
-        }
+  $result: ();
 
-        $result: append($result, nth($list, $i));
+  @for $i from 1 through $length {
+    @if $i == $index {
+      @if is-true($value) {
+        $result: append($result, $value, list-separator($list));
+      }
     }
 
-    @return $result;
+    $result: append($result, nth($list, $i), list-separator($list));
+  }
+
+  @return $result;
 }

data/stylesheets/SassyLists/_intersection.scss

@@ -2,27 +2,26 @@
 // -------------------------------------------------------------------------------
 // @documentation http://sassylists.com/documentation/#intersection
 // -------------------------------------------------------------------------------
-// @example intersection(a b c d, a c d, e d a f) => a d
-// -------------------------------------------------------------------------------
 // @param $list [List] : first list
 // @param $lists [ArgList] : other lists
 // -------------------------------------------------------------------------------
 // @return [List]
 
 @function intersection($list, $lists...) {
-    $result: $list;
-
-    @each $list in $lists {
-        $temp: ();
+  $result: $list;
 
-        @each $item in $result {
-            @if not not index($list, $item) {
-                $temp: append($temp, $item);
-            }
-        }
+  @each $list in $lists {
+    $temp: ();
 
-        $result: $temp;
+    @each $item in $result {
+      @if not not index($list, $item) {
+        $temp: append($temp, $item, list-separator($list));
+      }
     }
 
-    @return $result;
+    $result: $temp;
+  }
+
+  $result: remove-duplicates($result);
+  @return if(length($result) == 1, nth($result, 1), $result);
 }

data/stylesheets/SassyLists/_is-symmetrical.scss

@@ -6,20 +6,15 @@
 // -------------------------------------------------------------------------------
 // @dependence `reverse()`
 // -------------------------------------------------------------------------------
-// @example is-symmetrical(a b c d e)   => false
-// @example is-symmetrical(a b c b a)   => true
-// @example is-symmetrical(a (b c d) a) => true
-// -------------------------------------------------------------------------------
 // @param $list [List] : list
 // -------------------------------------------------------------------------------
 // @return [Boolean]
 
 @function is-symmetrical($list) {
-    $reverse: reverse($list);
-    @return $reverse == reverse($reverse);  
+  @return $list == reverse($list);
 }
 
 // Alias
 @function is-mirror($list) {
-    @return is-symmetrical($list);
+  @return is-symmetrical($list);
 }

data/stylesheets/SassyLists/_last-index.scss

@@ -2,22 +2,20 @@
 // -------------------------------------------------------------------------------
 // @documentation http://sassylists.com/documentation/#last-index
 // -------------------------------------------------------------------------------
-// @example last-index(a b c a, a) => 4
-// @example last-index(a b c, z)   => null
-// -------------------------------------------------------------------------------
 // @param $list [List] : list
 // @param $value [Literal] : value to be searched for
 // -------------------------------------------------------------------------------
 // @return [Number] | null
 
 @function last-index($list, $value) {
+  $length: length($list);
 
-    @for $i from length($list) * -1 through -1 {
-        $i: abs($i);
-        @if nth($list, $i) == $value {
-            @return $i;
-        }
+  @for $i from $length * -1 through -1 {
+    $i: abs($i);
+    @if nth($list, $i) == $value {
+      @return $i;
     }
+  }
 
-    @return null;
+  @return null;
 }

data/stylesheets/SassyLists/_last.scss

@@ -4,17 +4,22 @@
 // -------------------------------------------------------------------------------
 // @alias `tail()`
 // -------------------------------------------------------------------------------
-// @example last(a b c) => c
-// -------------------------------------------------------------------------------
 // @param $list [List] : list
 // -------------------------------------------------------------------------------
-// @return [Literal]
+// @raise [Error] if list is empty
+// -------------------------------------------------------------------------------
+// @return [Literal] | false
 
 @function last($list) {
-    @return nth($list, length($list));
+  @if length($list) == 0 {
+    @warn "Cannot find last item of empty list.";
+    @return false;
+  }
+
+  @return nth($list, length($list));
 }
 
 // Alias
 @function tail($list) {
-    @return last($list);
+  @return last($list);
 }