SassyLists 1.0.0 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b2e1d3071bfb06481f5102612d0495a431178ad9
+  data.tar.gz: b1d0c2721ba8f7aa9bf38371b4fecf962ffbd3b9
+SHA512:
+  metadata.gz: 3b8273705e9a19ae955d360a9de7e0824100ff152913931920df01fffaa4f8f5e4e8bf689ed83c0ba251ba1ae668cf85a25042ace10bc7826236af832679c3fb
+  data.tar.gz: 768055613e94b9c5ec940e2eac79749722e2285f4a4c9436f920ffe69d4d1036cd00075101103937940eaf4b009b9486607d0c6b7ec999c4d4a7ad9a0c79f958

data/CHANGELOG.md

@@ -1,35 +1,36 @@
-# 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
-* `0.4.6`: fixing an issue when passing an empty list to `chunk()` and improved code quality
-* `0.4.5`: making `sort()` able to return in descending order
-* `0.4.4`: fixing a typo in `purge()`
-* `0.4.3`: improving `insert-nth()`, `prepend()`, `replace-nth()` and `replace()` to prevent from adding empty lists
-* `0.4.2`: improving `insert-nth()` and cleaning some indentation issues
-* `0.4.1`: improving `intersection()` perf
-* `0.4.0`: adding `intersection()`
-* `0.3.5`: improving `debug()`, `to-string()` and `chunk()`
-* `0.3.4`: fixing a minor issue in `insert-nth()`, `replace-nth()` and `prepend()`
-* `0.3.3`: removing dependence to `purge()` from all functions; fixed an issue with `sort()`; fixed an issue with error messages
-* `0.3.2`: removing dependence to `purge()` from `replace()`
-* `0.3.1`: adding aliases and cleaned `to-string()`
-* `0.3.0`: adding `contains()`, `flatten()`, `union()`
-* `0.2.4`: improving `debug()`
-* `0.2.3`: fixing important issues with comments
-* `0.2.2`: moving all comments to invisible
-* `0.2.1`: fixing an issue with `random-value()`
-* `0.2.0`: adding `random-value()`
-* `0.1.4`: fixing an issue with `sort()`, `is-symmetrical()`
-* `0.1.3`: fixing an issue with `sort()`
-* `0.1.2`: improving `debug()`
-* `0.1.1`: initial commit
+# Changelog
+
+* `1.1.0`: added `walk()` and `tail()`, updated backward loops and fixed broken tests
+* `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
+* `0.4.6`: fixing an issue when passing an empty list to `chunk()` and improved code quality
+* `0.4.5`: making `sort()` able to return in descending order
+* `0.4.4`: fixing a typo in `purge()`
+* `0.4.3`: improving `insert-nth()`, `prepend()`, `replace-nth()` and `replace()` to prevent from adding empty lists
+* `0.4.2`: improving `insert-nth()` and cleaning some indentation issues
+* `0.4.1`: improving `intersection()` perf
+* `0.4.0`: adding `intersection()`
+* `0.3.5`: improving `debug()`, `to-string()` and `chunk()`
+* `0.3.4`: fixing a minor issue in `insert-nth()`, `replace-nth()` and `prepend()`
+* `0.3.3`: removing dependence to `purge()` from all functions; fixed an issue with `sort()`; fixed an issue with error messages
+* `0.3.2`: removing dependence to `purge()` from `replace()`
+* `0.3.1`: adding aliases and cleaned `to-string()`
+* `0.3.0`: adding `contains()`, `flatten()`, `union()`
+* `0.2.4`: improving `debug()`
+* `0.2.3`: fixing important issues with comments
+* `0.2.2`: moving all comments to invisible
+* `0.2.1`: fixing an issue with `random-value()`
+* `0.2.0`: adding `random-value()`
+* `0.1.4`: fixing an issue with `sort()`, `is-symmetrical()`
+* `0.1.3`: fixing an issue with `sort()`
+* `0.1.2`: improving `debug()`
+* `0.1.1`: initial commit

data/lib/SassyLists.rb

@@ -1,16 +1,14 @@
-require 'compass'
-extension_path = File.expand_path(File.join(File.dirname(__FILE__), ".."))
-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 = "1.0.0"
-  DATE = "2014-03-09"
-end
-
-module Sass::Script::Functions
-  def random(max = Sass::Script::Number.new(100))
-    Sass::Script::Number.new(rand(max.value), max.numerator_units, max.denominator_units)
-  end
+require 'compass'
+extension_path = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+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 = "1.1.0"
+  DATE = "2014-06-28"
+end
+
+module Sass::Script::Functions
+
 end

data/stylesheets/SassyLists/_chunk.scss

@@ -1,42 +1,42 @@
-// Chunks $list into $size large lists
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation/#chunk
-// -------------------------------------------------------------------------------
-// @param $list [List] : list
-// @param $size [Number] : length of lists
-// -------------------------------------------------------------------------------
-// @raise [Error] if $size is not a number
-// -------------------------------------------------------------------------------
-// @return [List] | false
-
-@function chunk($list, $size) {
-  @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;
-    }
-
-    $result: append($result, $tmp);
-  }
-
-  @return $result;
+// Chunks $list into $size large lists
+//
+// @ignore Documentation: http://sassylists.com/documentation/#chunk
+//
+// @param {List}   $list  - list to chunk
+// @param {Number} $size  - length of lists
+//
+// @throws $size is not a number for `chunk`.
+//
+// @return {List | Bool}
+
+@function chunk($list, $size) {
+  @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;
+    }
+
+    $result: append($result, $tmp);
+  }
+
+  @return $result;
 }

data/stylesheets/SassyLists/_contain.scss

@@ -1,19 +1,18 @@
-// Returns whether $list contains $value
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation/#contain
-// -------------------------------------------------------------------------------
-// @alias `include()`
-// -------------------------------------------------------------------------------
-// @param $list [List] : list
-// @param $value [Literal] : value to look for
-// -------------------------------------------------------------------------------
-// @return [Boolean]
-
-@function contain($list, $value) {
-  @return not not index($list, $value);
-}
-
-// Alias
-@function include($list, $value) {
-  @return contain($list, $value);
+// Returns whether $list contains $value
+//
+// @ignore Documentation: http://sassylists.com/documentation/#contain
+//
+// @param {List}    $list  - list to check
+// @param {*}       $value - value to look for
+//
+// @return {Bool}
+
+@function contain($list, $value) {
+  @return not not index($list, $value);
+}
+
+// @alias contain
+
+@function include($list, $value) {
+  @return contain($list, $value);
 }

data/stylesheets/SassyLists/_count-values.scss

@@ -1,19 +1,19 @@
-// Counts the number of occurrences of each value of $list
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation/#count-values
-// -------------------------------------------------------------------------------
-// @param $list [List] : list
-// -------------------------------------------------------------------------------
-// @return [Map]
-
-@function count-values($list) {
-  $map: ();
-
-  @each $item in $list {
-    $index: map-get($map, $item);
-    $value: if($index, $index + 1, 1);
-    $map: map-merge($map, ($item: $value));
-  }
-
-  @return $map;
+// Counts the number of occurrences of each value of $list
+//
+// @ignore Documentation: http://sassylists.com/documentation/#count-values
+//
+// @param {List} $list - list to count values from
+//
+// @return {Map} Values mapped to their count
+
+@function count-values($list) {
+  $map: ();
+
+  @each $item in $list {
+    $index: map-get($map, $item);
+    $value: if($index, $index + 1, 1);
+    $map: map-merge($map, ($item: $value));
+  }
+
+  @return $map;
 }

data/stylesheets/SassyLists/_debug.scss

@@ -1,94 +1,96 @@
-// Returns $list as a string
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation/#debug
-// -------------------------------------------------------------------------------
-// @param $list [List] : list
-// @param $pre [Boolean] : enable/disable variables type and proper indentation
-// @param $level [Number] : internal variable for recursivity
-// -------------------------------------------------------------------------------
-// @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;
-  }
-
-  $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);
-    }
-
-    @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 {
-      $result: $result + "," + $break;
-    }
-  }
-
-  $result: $result + $break + if($pre, if($level > 1, $indent, ""), " ") + "]";
-
-  @return quote($result);
-}
-
-// Mixin displaying clean debug
-// -------------------------------------------------------------------------------
-// @param $list [List] : list
-
-@mixin debug($list) {
-  body:before {
-    content: debug($list, true)               !important;
-
-    display: block                            !important;
-    margin: 1em                               !important;
-    padding: .5em                             !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;
-  }
-}
+// Returns $list as a string
+//
+// @ignore Documentation: http://sassylists.com/documentation/#debug
+//
+// @param {List}   $list          - list to debug
+// @param {Bool}   $pre   (false) - enable/disable variables type and proper indentation
+// @param {Number} $level (1)     - internal variable for recursion
+//
+// @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;
+  }
+
+  $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);
+    }
+
+    @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 {
+      $result: $result + "," + $break;
+    }
+  }
+
+  $result: $result + $break + if($pre, if($level > 1, $indent, ""), " ") + "]";
+
+  @return quote($result);
+}
+
+// Mixin displaying clean debug
+//
+// @param {List} $list - list
+//
+// @requires {function} debug
+
+@mixin debug($list) {
+  body:before {
+    content: debug($list, true)               !important;
+
+    display: block                            !important;
+    margin: 1em                               !important;
+    padding: .5em                             !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;
+  }
+}

data/stylesheets/SassyLists/_explode.scss

@@ -1,49 +1,50 @@
-// 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);
+// Explode $string into a list using $break as a breaker
+//
+// @ignore Documentation: http://sassylists.com/documentation/#explode
+//
+// @param {String} $string         - string to explode
+// @param {String} $separator ('') - string to use as a delimiter
+//
+// @throws $string is not a string for `explode`.
+// @throws $delimiter is not a string for `explode`.
+//
+// @return {List | Bool}
+
+@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

@@ -1,25 +1,24 @@
-// Returns first element of $list
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation/#first
-// -------------------------------------------------------------------------------
-// @alias `head()`
-// -------------------------------------------------------------------------------
-// @param $list [List] : list
-// -------------------------------------------------------------------------------
-// @raise [Error] if either $list is empty
-// -------------------------------------------------------------------------------
-// @return [Literal] | false
-
-@function first($list) {
-  @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);
+// Returns first element of $list
+//
+// @ignore Documentation: http://sassylists.com/documentation/#first
+//
+// @param {List} $list - list to retrieve first item from
+//
+// @throws Cannot find first item of empty list.
+//
+// @return {*}
+
+@function first($list) {
+  @if length($list) == 0 {
+    @warn "Cannot find first item of empty list.";
+    @return false;
+  }
+
+  @return nth($list, 1);
+}
+
+// @alias first
+
+@function head($list) {
+  @return first($list);
 }