SassyLists 1.0.0 → 1.1.0

data/stylesheets/SassyLists/_remove-nth.scss

@@ -1,21 +1,20 @@
-// Removes value from $list at index $index
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation/#remove-nth
-// -------------------------------------------------------------------------------
-// @alias `without-nth()`
-// -------------------------------------------------------------------------------
-// @dependence `replace-nth()`
-// -------------------------------------------------------------------------------
-// @param $list [List] : list
-// @param $index [Number] : index to remove
-// -------------------------------------------------------------------------------
-// @return [List] | false
-
-@function remove-nth($list, $index) {
-  @return replace-nth($list, $index, "");
-}
-
-// Alias
-@function without-nth($list, $index) {
-  @return remove-nth($list, $index);
+// Removes value from $list at index $index
+//
+// @ignore Documentation: http://sassylists.com/documentation/#remove-nth
+//
+// @requires replace-nth
+//
+// @param {List}   $list  - list to remove value from
+// @param {Number} $index - index to remove
+//
+// @return {List | Bool}
+
+@function remove-nth($list, $index) {
+  @return replace-nth($list, $index, "");
+}
+
+// @alias remove-nth
+
+@function without-nth($list, $index) {
+  @return remove-nth($list, $index);
 }

data/stylesheets/SassyLists/_remove.scss

@@ -1,22 +1,21 @@
-// Removes value(s) $value from $list
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation/#remove
-// -------------------------------------------------------------------------------
-// @alias `without()`
-// -------------------------------------------------------------------------------
-// @dependence `replace()`
-// -------------------------------------------------------------------------------
-// @param $list [List] : list
-// @param $value [Literal] : value to remove
-// @param $recursive [Boolean] : enable / disable recursivity
-// -------------------------------------------------------------------------------
-// @return [List]
-
-@function remove($list, $value) {
-  @return replace($list, $value, null);
-}
-
-// Alias
-@function without($list, $value) {
-  @return remove($list, $value);
+// Removes value(s) $value from $list
+//
+// @ignore Documentation: http://sassylists.com/documentation/#remove
+//
+// @requires replace
+//
+// @param {List}    $list      - list to update
+// @param {*}       $value     - value to remove
+// @param {Bool}    $recursive - enable/disable recursion
+//
+// @return {List}
+
+@function remove($list, $value) {
+  @return replace($list, $value, null);
+}
+
+// @alias remove
+
+@function without($list, $value) {
+  @return remove($list, $value);
 }

data/stylesheets/SassyLists/_replace-nth.scss

@@ -1,25 +1,24 @@
-// Replaces value at $index from $list by $value
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation/#replace-nth
-// -------------------------------------------------------------------------------
-// @dependence `purge()`
-// -------------------------------------------------------------------------------
-// @param $list [List] : list
-// @param $index [Number] : index to update
-// @param $value [Literal] : new value for index $index
-// -------------------------------------------------------------------------------
-// @raise [Error] if $index isn't an integer
-// @raise [Error] if $index is 0
-// @raise [Error] if abs value of $index is strictly greater than length of $list
-// -------------------------------------------------------------------------------
-// @return [List] | false
-
-@function replace-nth($list, $index, $value) {
-  @if type-of($index) != "number" or $index == 0 or abs($index) > length($list) {
-    @warn "Invalid index (#{$index}) for `replace-nth`.";
-    @return false;
-  }
-
-  $list: set-nth($list, $index, $value);
-  @return if(not is-true($value), purge($list), $list);
-}
+// Replaces value at $index from $list by $value
+//
+// @ignore Documentation: http://sassylists.com/documentation/#replace-nth
+//
+// @requires purge
+// @requires is-true
+//
+// @param {List}   $list  - list to update
+// @param {Number} $index - index to update
+// @param {*}      $value - new value for index
+//
+// @throws Invalid index $index for `replace-nth`.
+//
+// @return {List | Bool}
+
+@function replace-nth($list, $index, $value) {
+  @if type-of($index) != "number" or $index == 0 or abs($index) > length($list) {
+    @warn "Invalid index (#{$index}) for `replace-nth`.";
+    @return false;
+  }
+
+  $list: set-nth($list, $index, $value);
+  @return if(not is-true($value), purge($list), $list);
+}

data/stylesheets/SassyLists/_replace.scss

@@ -1,28 +1,30 @@
-// Replaces $old by $new in $list
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation.html#replace
-// -------------------------------------------------------------------------------
-// @param $list [List] : list
-// @param $old [Literal] : value to replace
-// @param $value [Literal] : new value for $old
-// -------------------------------------------------------------------------------
-// @return [List]
-
-@function replace($list, $old, $value) {
-  $running: true;
-
-  @while $running {
-    $index: index($list, $old);
-
-    @if not $index {
-      $running: false;
-    }
-
-    @else {
-      $list: set-nth($list, $index, $value);
-    }
-
-  }
-
-  @return if(not is-true($value), purge($list), $list);
+// Replaces $old by $new in $list
+//
+// @ignore Documentation: http://sassylists.com/documentation.html#replace
+//
+// @requires is-true
+//
+// @param {List}    $list  - list to update
+// @param {*}       $old   - value to replace
+// @param {*}       $value - new value for $old
+//
+// @return {List}
+
+@function replace($list, $old, $value) {
+  $running: true;
+
+  @while $running {
+    $index: index($list, $old);
+
+    @if not $index {
+      $running: false;
+    }
+
+    @else {
+      $list: set-nth($list, $index, $value);
+    }
+
+  }
+
+  @return if(not is-true($value), purge($list), $list);
 }

data/stylesheets/SassyLists/_reverse.scss

@@ -1,31 +1,30 @@
-// Reverses the order of $list
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation/#reverse
-// -------------------------------------------------------------------------------
-// @alias `mirror()`
-// -------------------------------------------------------------------------------
-// @param $list [List] : list
-// -------------------------------------------------------------------------------
-// @return [List]
-
-@function reverse($list) {
-  $length: length($list);
-  $end: floor($length/2);
-
-  @if $length < 2 {
-    @return $list;
-  }
-
-  @for $i from 1 through $end {
-    $tmp: nth($list, $i);
-    $list: set-nth($list, $i, nth($list, -$i));
-    $list: set-nth($list, -$i, $tmp);
-  }
-
-  @return $list;
-}
-
-// Alias
-@function mirror($list) {
-  @return reverse($list);
+// Reverses the order of $list
+//
+// @ignore Documentation: http://sassylists.com/documentation/#reverse
+//
+// @param {List} $list - list to revers
+//
+// @return {List}
+
+@function reverse($list) {
+  $length: length($list);
+  $end: floor($length/2);
+
+  @if $length < 2 {
+    @return $list;
+  }
+
+  @for $i from 1 through $end {
+    $tmp: nth($list, $i);
+    $list: set-nth($list, $i, nth($list, -$i));
+    $list: set-nth($list, -$i, $tmp);
+  }
+
+  @return $list;
+}
+
+// @alias reverse
+
+@function mirror($list) {
+  @return reverse($list);
 }

data/stylesheets/SassyLists/_shuffle.scss

@@ -1,31 +1,29 @@
-// Shuffle function using Fisher-Yates method
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation/#shuffle
-// -------------------------------------------------------------------------------
-// @alias `randomize()`
-// -------------------------------------------------------------------------------
-// @param $list [List] : list
-// -------------------------------------------------------------------------------
-// @return [List]
-
-@function shuffle($list) {
-  $length: length($list);
-
-  @if $length < 2 {
-    @return $list;
-  }
-
-  @for $i from -1 * $length through -1 {
-    $i: abs($i);
-    $j: random($length - 1) + 1;
-    $tmp: nth($list, $i);
-    $list: set-nth($list, $i, nth($list, $j));
-    $list: set-nth($list, $j, $tmp);
-  }
-  @return $list;
-}
-
-// Alias
-@function randomize($list) {
-  @return shuffle($list);
-}
+// Shuffle function using Fisher-Yates method
+//
+// @ignore Documentation: http://sassylists.com/documentation/#shuffle
+//
+// @param {List} $list - list to shuffle
+//
+// @return {List}
+
+@function shuffle($list) {
+  $length: length($list);
+
+  @if $length < 2 {
+    @return $list;
+  }
+
+  @for $i from $length through 1 {
+    $j: random($length - 1) + 1;
+    $tmp: nth($list, $i);
+    $list: set-nth($list, $i, nth($list, $j));
+    $list: set-nth($list, $j, $tmp);
+  }
+  @return $list;
+}
+
+// @alias shuffle
+
+@function randomize($list) {
+  @return shuffle($list);
+}

data/stylesheets/SassyLists/_slice.scss

@@ -1,49 +1,49 @@
-// Slices $list between $start and $end
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation/#slice
-// -------------------------------------------------------------------------------
-// @param $list [List] : list
-// @param $start [Number] : start index
-// @param $end [Number] : end index
-// -------------------------------------------------------------------------------
-// @raise [Error] if $start or $end aren't integers
-// @raise [Error] if $start is greater than $end
-// @raise [Error] if $start or $end is strictly lesser than 1
-// @raise [Error] if $start is strictly greater than length of $list
-// @raise [Error] if $end is strictly greater than length of $list
-// -------------------------------------------------------------------------------
-// @return [List] | false
-
-@function slice($list, $start: 1, $end: length($list)) {
-  @if type-of($start) != "number" or type-of($end) != "number" {
-    @warn "List indexes #{$start} and #{$end} must be numbers for `slice`.";
-    @return false;
-  }
-
-  @if $start > $end {
-    @warn "Start index is #{$start} but has to be lesser than or equals to the end index (#{$end}) for `slice`.";
-    @return false;
-  }
-
-  @if $start < 1 or $end < 1 {
-    @warn "List indexes must be non-zero integers for `slice`.";
-    @return false;
-  }
-
-  @if $start > length($list) {
-    @warn "Start index is #{$start} but list is only #{length($list)} items long for `slice`.";
-    @return false;
-  }
-
-  @if $end > length($list) {
-    @warn "End index is #{$end} but list is only #{length($list)} items long for `slice`.";
-    @return false;
-  }
-
-  $result: ();
-  @for $i from $start through $end {
-    $result: append($result, nth($list, $i), list-separator($list));
-  }
-
-  @return $result;
+// Slices $list between $start and $end
+//
+// @ignore Documentation: http://sassylists.com/documentation/#slice
+//
+// @param {List}   $list                  - list to slice
+// @param {Number} $start (1)             - start index
+// @param {Number} $end   (length($list)) - end index
+//
+// @throws List indexes $start and $end must be numbers for `slice`.
+// @throws Start index has to be lesser than or equals to the end index for `slice`.
+// @throws List indexes must be non-zero integers for `slice`.
+// @throws Start index has to be lesser than or equal to list length for `slice`.
+// @throws End index has to be lesser than or equal to list length for `slice`.
+//
+// @return {List | Bool}
+
+@function slice($list, $start: 1, $end: length($list)) {
+  @if type-of($start) != "number" or type-of($end) != "number" {
+    @warn "List indexes #{$start} and #{$end} must be numbers for `slice`.";
+    @return false;
+  }
+
+  @if $start > $end {
+    @warn "Start index is #{$start} but has to be lesser than or equals to the end index (#{$end}) for `slice`.";
+    @return false;
+  }
+
+  @if $start < 1 or $end < 1 {
+    @warn "List indexes must be non-zero integers for `slice`.";
+    @return false;
+  }
+
+  @if $start > length($list) {
+    @warn "Start index is #{$start} but list is only #{length($list)} items long for `slice`.";
+    @return false;
+  }
+
+  @if $end > length($list) {
+    @warn "End index is #{$end} but list is only #{length($list)} items long for `slice`.";
+    @return false;
+  }
+
+  $result: ();
+  @for $i from $start through $end {
+    $result: append($result, nth($list, $i), list-separator($list));
+  }
+
+  @return $result;
 }

data/stylesheets/SassyLists/_sort.scss

@@ -1,41 +1,40 @@
-// Sorts values of $list using quick-sort algorithm
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation/#sort
-// -------------------------------------------------------------------------------
-// @alias `order()`
-// -------------------------------------------------------------------------------
-// @dependence `str-compare()`
-// -------------------------------------------------------------------------------
-// @param $list [List] : list
-// @param $order [List] : order
-// -------------------------------------------------------------------------------
-// @return [List]
-
-@function sort($list, $order: "!" "#" "$" "%" "&" "'" "(" ")" "*" "+" "," "-" "." "/" "[" "\\" "]" "^" "_" "{" "|" "}" "~" "0" "1" "2" "3" "4" "5" "6" "7" "8" "9" "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") {
-  $less:  ();
-  $equal: ();
-  $large: ();
-  $length: length($list);
-
-  @if $length > 1 {
-    $seed: nth($list, ceil($length / 2));
-    @each $item in $list {
-      @if $item == $seed {
-        $equal: append($equal, $item, list-separator($list));
-      }
-      @else if str-compare($item, $seed, $order) {
-        $less: append($less, $item, list-separator($list));
-      }
-      @else if not str-compare($item, $seed, $order) {
-        $large: append($large, $item, list-separator($list));
-      }
-    }
-    @return join(join(sort($less, $order), $equal), sort($large, $order));
-  }
-  @return $list;
-}
-
-// Alias
-@function order($list) {
-  @return sort($list);
-}
+// Sorts values of $list using quick-sort algorithm
+//
+// @ignore Documentation: http://sassylists.com/documentation/#sort
+//
+// @requires str-compare
+//
+// @param {List} $list  - list to sort
+// @param {List} $order - order to respect
+//
+// @return {List}
+
+@function sort($list, $order: "!" "#" "$" "%" "&" "'" "(" ")" "*" "+" "," "-" "." "/" "[" "\\" "]" "^" "_" "{" "|" "}" "~" "0" "1" "2" "3" "4" "5" "6" "7" "8" "9" "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") {
+  $less:  ();
+  $equal: ();
+  $large: ();
+  $length: length($list);
+
+  @if $length > 1 {
+    $seed: nth($list, ceil($length / 2));
+    @each $item in $list {
+      @if $item == $seed {
+        $equal: append($equal, $item, list-separator($list));
+      }
+      @else if str-compare($item, $seed, $order) {
+        $less: append($less, $item, list-separator($list));
+      }
+      @else if not str-compare($item, $seed, $order) {
+        $large: append($large, $item, list-separator($list));
+      }
+    }
+    @return join(join(sort($less, $order), $equal), sort($large, $order));
+  }
+  @return $list;
+}
+
+// @alias sort
+
+@function order($list) {
+  @return sort($list);
+}

data/stylesheets/SassyLists/_sum.scss

@@ -1,28 +1,28 @@
-// Sums up all numeric values in $list
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation/#sum
-// -------------------------------------------------------------------------------
-// @param $list [List] : list
-// @param $force [Boolean] : enable / disable parseInt
-// -------------------------------------------------------------------------------
-// @return [Number]
-
-@function sum($list, $force: false) {
-  $result: 0;
-
-  @each $item in $list {
-    @if type-of($item) == number {
-
-      @if $force and not unitless($item) {
-        $item: $item / ($item * 0 + 1);
-      }
-
-      @if unitless($item) {
-        $result: $result + $item;
-      }
-
-    }
-  }
-
-  @return $result;
-}
+// Sums up all numeric values in $list
+//
+// @ignore Documentation: http://sassylists.com/documentation/#sum
+//
+// @param {List}    $list          - list
+// @param {Boolean} $force (false) - enable/disable parseInt
+//
+// @return {Number}
+
+@function sum($list, $force: false) {
+  $result: 0;
+
+  @each $item in $list {
+    @if type-of($item) == number {
+
+      @if $force and not unitless($item) {
+        $item: $item / ($item * 0 + 1);
+      }
+
+      @if unitless($item) {
+        $result: $result + $item;
+      }
+
+    }
+  }
+
+  @return $result;
+}

data/stylesheets/SassyLists/_tail.scss

@@ -0,0 +1,19 @@
+// Returns the tail of $list: all items except the first (head)
+//
+// @ignore Documentation: http://sassylists.com/documentation/#tail
+//
+// @requires slice
+//
+// @param {List} $list - list to retrieve tail from
+//
+// @return {List | Bool}
+
+@function tail($list) {
+  @return slice($list, 2);
+}
+
+// @alias tail
+
+@function rest($list) {
+  @return tail($list);
+}

data/stylesheets/SassyLists/_to-string.scss

@@ -1,27 +1,26 @@
-// Joins all elements of $list with $glue
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation/#to-string
-// -------------------------------------------------------------------------------
-// @alias `stringify()`
-// -------------------------------------------------------------------------------
-// @param $list [List] : list
-// @param $glue [String] : value to use as a join string
-// -------------------------------------------------------------------------------
-// @return [String]
-
-@function to-string($list, $glue: '') {
-  $result: '';
-  $length: length($list);
-
-  @for $i from 1 through $length {
-    $item: nth($list, $i);
-    $result: $result + if(length($item) > 1, to-string($item, $glue), $item + $glue);
-  }
-
-  @return quote(str-slice($result, 1, str-length($glue) * -1 - 1));
-}
-
-// Alias
-@function stringify($list, $glue: '') {
-  @return to-string($list, $glue);
+// Joins all elements of $list with $glue
+//
+// @ignore Documentation: http://sassylists.com/documentation/#to-string
+//
+// @param {List}   $list      - list to cast
+// @param {String} $glue ('') - value to use as a join string
+//
+// @return {String}
+
+@function to-string($list, $glue: '') {
+  $result: '';
+  $length: length($list);
+
+  @for $i from 1 through $length {
+    $item: nth($list, $i);
+    $result: $result + if(length($item) > 1, to-string($item, $glue), $item + $glue);
+  }
+
+  @return quote(str-slice($result, 1, str-length($glue) * -1 - 1));
+}
+
+// @alias to-string
+
+@function stringify($list, $glue: '') {
+  @return to-string($list, $glue);
 }