SassyLists 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9188bd3fa596049952a7632069d04150021289bb
-  data.tar.gz: 2b8cd2fddcbe99bcaffa6e11c552eba1f9468bbe
+  metadata.gz: a296e7541de900b0667d9adc5982680695baf408
+  data.tar.gz: cfe6a3f3016520920a2109556c0315bef0fa0f59
 SHA512:
-  metadata.gz: 73b07f9d83ce6bfb68b36fda09a3d9ba3f1a3209d571dc8c3d383cf5c6b34cec1ca62438952e2b0f26ca03ce6145ef3384d59497d8c961dc5b1401736899b4d8
-  data.tar.gz: 9a6b283f587c8ed177db46f4b5beb675da1687e38f6fd2a07a19577736700c9714c53a6ed9320398f8a4ff705c7d28a4980ba5dbb06c77ab316a2a9466a12217
+  metadata.gz: 130887373e83c97df31b98774bc78f8becd565fedbe99b2cb29278938ea0b1b7b95bbbda4038aded18c2881bc3c9ceea66d1ec6431e1c9d8580475867b4193dd
+  data.tar.gz: c832a9b26caee25bae587bf9519fd3b0d1a49d8256ec4c88837f24e7dcee0e1ecc40f210449ccb90628e4a1e364467cbe78ef6c2973c4e19c7554f48f45397cb

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 # Changelog
 
-* `1.1.0`: added `walk()` and `tail()`, updated backward loops and fixed broken tests
+* `2.0.0`: 
+    * adding `to-map()`, `every()` and `some()`
+    * adding and improved tests
+    * prefixing all functions with `sl-`
+    * fixing an issue with `random-value()` sometimes failing
+    * changing all `false` returns into `null` in case of error
+    * removing Compass dependency
+* `1.1.0`: adding `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()`

data/README.md

@@ -0,0 +1,73 @@
+# SassyLists [![Gem Version](https://badge.fury.io/rb/SassyLists.png)](http://badge.fury.io/rb/SassyLists)
+
+Here is a [Compass Extension](http://compass-style.org/) providing you all functions you need to manipulate your [Sass](http://sass-lang.com/) lists. See complete documentation [here](http://sassylists.com/).
+
+## How to use it
+
+### Install with Gem 
+
+1. `gem install SassyLists`
+2. Add `require 'SassyLists'` to your `config.rb`
+3. Import it in your stylesheets with `@import 'SassyLists'`
+
+### Install with [Bower](http://bower.io/ "BOWER: A package manager for the web")
+1. `bower install SassyLists --save-dev`
+2. Import the partial in your Sass files
+
+## What's in there? 
+
+* `sl-chunk()`: returns whether list contains $value
+* `sl-contain()`: returns whether the list contains the value
+* `sl-count-values()`: counts the number of occurrences of each value of list
+* `sl-debug()`: returns list as a string
+* `sl-every()`: returns whether all items from list pass test from given function
+* `sl-explode()`: explodes a string into a list using a string as a delimiter
+* `sl-first()`: returns first item in list
+* `sl-flatten()`: turns multidimensional list into a one-level list
+* `sl-insert-nth()`: inserts value at index
+* `sl-intersection()`: returns a list of shared values across all given lists
+* `sl-is-symmetrical()`: checks if list is symmetrical
+* `sl-last()`: returns last item in list
+* `sl-last-index()`: returns last index of value in list
+* `sl-loop()`: shifts indexes in list
+* `sl-prepend()`: prepends value to list
+* `sl-purge()`: removes all `false` and `null` values from list
+* `sl-random-value()`: returns random value from list
+* `sl-remove()`: removes value in list
+* `sl-remove-duplicates()`: removes duplicate values from list
+* `sl-remove-nth()`: removes value at index
+* `sl-replace()`: replaces value in list
+* `sl-replace-nth()`: replaces value at index
+* `sl-reverse()`: reverses list
+* `sl-shuffle()`: shuffles list
+* `sl-slice()`: slices list
+* `sl-sort()`: sorts list
+* `sl-some()`: returns whether some items from list pass test from given function
+* `sl-sum()`: sums all unitless values in list
+* `sl-tail()`: returns anything but the first element in list
+* `sl-to-map()`: casts list as map using indexes as keys
+* `sl-to-string()`: casts list as string (JS `.join()`)
+* `sl-union()`: returns a list of values from given lists minus duplicates
+* `sl-walk()`: applies a function to every item of list
+
+If you feel like an explorer, you can have a look at the code [here](https://github.com/Team-Sass/SassyLists/tree/master/stylesheets).
+
+## Requirements
+
+* Sass ~> 3.3.0
+* Compass ~> 1.0.0
+
+If you are looking for the last version of SassyLists running on Sass 3.2, install `0.4.9`.
+
+Some functions depend on other functions. If you include functions individually, make sure to check for these dependencies in their respective docs.
+
+## Also read
+
+* [Official site](http://sassylists.com)
+* [Advanced Sass list functions](http://hugogiraudel.com/2013/08/08/advanced-sass-list-functions/)
+* [Advanced Sass list functions again](http://hugogiraudel.com/2013/10/09/advanced-sass-list-functions-again/)
+* [How I made a Sass debug function](http://hugogiraudel.com/2013/10/21/sass-debug/)
+
+## Credits
+
+A million thanks to [Vinay Raghu](http://viii.in/) for making this Compass extension out of my original work and to [Team-Sass](https://github.com/Team-Sass) for their [Compass Extension template](https://github.com/Team-Sass/Compass-Extension-Template).

data/lib/SassyLists.rb

@@ -1,14 +1,21 @@
-require 'compass'
-extension_path = File.expand_path(File.join(File.dirname(__FILE__), ".."))
-Compass::Frameworks.register('SassyLists', :path => extension_path)
+extension_path   = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+stylesheets_path = File.join(extension_path, 'stylesheets')
+
+if (defined? Compass)
+  Compass::Frameworks.register('SassyLists', :path => extension_path)
+else
+  # compass not found, register on the Sass path via the environment.
+  if ENV.has_key?("SASS_PATH")
+    ENV["SASS_PATH"] = ENV["SASS_PATH"] + File::PATH_SEPARATOR + stylesheets_path
+  else
+    ENV["SASS_PATH"] = stylesheets_path
+  end
+end
 
 #  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.1"
-  DATE = "2014-06-28"
+  VERSION = "2.0.0"
+  DATE = "2014-06-30"
 end
 
-module Sass::Script::Functions
-
-end

data/stylesheets/SassyLists/_chunk.scss

@@ -1,18 +1,18 @@
-// Chunks $list into $size large lists
+// 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`.
+// @throws $size is not a number for `sl-chunk`.
 //
-// @return {List | Bool}
+// @return {List | Null}
 
-@function chunk($list, $size) {
+@function sl-chunk($list, $size) {
   @if type-of($size) != "number" {
-    @warn "#{$size} is not a number for `chunk`.";
-    @return false;
+    @warn "#{$size} is not a number for `sl-chunk`.";
+    @return null;
   }
 
   @if $size >= length($list) {

data/stylesheets/SassyLists/_contain.scss

@@ -1,4 +1,4 @@
-// Returns whether $list contains $value
+// Returns whether `$list` contains `$value`.
 //
 // @ignore Documentation: http://sassylists.com/documentation/#contain
 //
@@ -7,12 +7,12 @@
 //
 // @return {Bool}
 
-@function contain($list, $value) {
+@function sl-contain($list, $value) {
   @return not not index($list, $value);
 }
 
-// @alias contain
+// @alias sl-contain
 
-@function include($list, $value) {
-  @return contain($list, $value);
+@function sl-include($list, $value) {
+  @return sl-contain($list, $value);
 }

data/stylesheets/SassyLists/_count-values.scss

@@ -1,4 +1,4 @@
-// Counts the number of occurrences of each value of $list
+// Counts the number of occurrences of each value of `$list`.
 //
 // @ignore Documentation: http://sassylists.com/documentation/#count-values
 //
@@ -6,7 +6,7 @@
 //
 // @return {Map} Values mapped to their count
 
-@function count-values($list) {
+@function sl-count-values($list) {
   $map: ();
 
   @each $item in $list {

data/stylesheets/SassyLists/_debug.scss

@@ -1,4 +1,4 @@
-// Returns $list as a string
+// Returns `$list` as a string, prettified if `$pre` is set to true.
 //
 // @ignore Documentation: http://sassylists.com/documentation/#debug
 //
@@ -8,7 +8,7 @@
 //
 // @return {String}
 
-@function debug($list, $pre: false, $level: 1) {
+@function sl-debug($list, $pre: false, $level: 1) {
   @if length($list) == 0 {
     @return "( )";
   }
@@ -35,7 +35,7 @@
     @if length($item) > 1 {
       $result: $result
         + if($pre, "(list: " + length($item) + ") ", "")
-        + debug($item, $pre, $level + 1);
+        + sl-debug($item, $pre, $level + 1);
     }
 
     @else {
@@ -74,11 +74,11 @@
 //
 // @param {List} $list - list
 //
-// @requires {function} debug
+// @requires {function} sl-debug
 
-@mixin debug($list) {
+@mixin sl-debug($list) {
   body:before {
-    content: debug($list, true)               !important;
+    content: sl-debug($list, true)            !important;
 
     display: block                            !important;
     margin: 1em                               !important;

data/stylesheets/SassyLists/_every.scss

@@ -0,0 +1,17 @@
+// Tests whether all items from `$list` pass the test implemented by `$function`.
+//
+// @param {List}    $list     - list to run test against
+// @param {String}  $function - function to run against every item from list
+// @param {ArgList} $args     - extra arguments to pass to the function
+//
+// @return {Bool}
+ 
+@function sl-every($list, $function, $args...) {
+  @each $item in $list {
+    @if not call($function, $item, $args...) {
+      @return false;
+    } 
+  }
+  
+  @return true;
+}

data/stylesheets/SassyLists/_explode.scss

@@ -1,24 +1,24 @@
-// Explode $string into a list using $break as a breaker
+// Explode `$string` into a list using `$delimiter` as a delimiter.
 //
 // @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`.
+// @throws $string is not a string for `sl-explode`.
+// @throws $delimiter is not a string for `sl-explode`.
 //
-// @return {List | Bool}
+// @return {List | Null}
 
-@function explode($string, $delimiter: '') {
+@function sl-explode($string, $delimiter: '') {
   @if type-of($string) != "string" {
-    @warn "`explode` function expecting a string; #{type-of($string)} given.";
-    @return false;
+    @warn "`sl-explode` function expecting a string; #{type-of($string)} given.";
+    @return null;
   }
 
   @if type-of($delimiter) != "string" {
-    @warn "`explode` function expecting a string; #{type-of($delimiter)} given.";
-    @return false;
+    @warn "`sl-explode` function expecting a string; #{type-of($delimiter)} given.";
+    @return null;
   }
 
   $result: ();
@@ -28,6 +28,7 @@
     @for $i from 1 through $length {
       $result: append($result, str-slice($string, $i, $i));
     }
+    
     @return $result;
   }
 
@@ -36,9 +37,11 @@
 
   @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);

data/stylesheets/SassyLists/_first.scss

@@ -1,4 +1,4 @@
-// Returns first element of $list
+// Returns first element of `$list`.
 //
 // @ignore Documentation: http://sassylists.com/documentation/#first
 //
@@ -8,17 +8,17 @@
 //
 // @return {*}
 
-@function first($list) {
+@function sl-first($list) {
   @if length($list) == 0 {
     @warn "Cannot find first item of empty list.";
-    @return false;
+    @return null;
   }
 
   @return nth($list, 1);
 }
 
-// @alias first
+// @alias sl-first
 
-@function head($list) {
-  @return first($list);
+@function sl-head($list) {
+  @return sl-first($list);
 }

data/stylesheets/SassyLists/_flatten.scss

@@ -1,4 +1,4 @@
-// Turns multidimensional $list into a one-level list
+// Turns multidimensional `$list` into a one-level list.
 //
 // @ignore Documentation: http://sassylists.com/documentation.html#flatten
 //
@@ -6,7 +6,7 @@
 //
 // @return {List}
 
-@function flatten($list) {
+@function sl-flatten($list) {
   $result: ();
 
   @if length($list) == 1 {
@@ -15,7 +15,7 @@
 
   @each $item in $list {
     @if length($item) > 1 {
-      $flatten: flatten($item);
+      $flatten: sl-flatten($item);
       @each $i in $flatten {
         $result: append($result, $i, list-separator($list));
       }
@@ -29,8 +29,8 @@
   @return $result;
 }
 
-// @alias flatten
+// @alias sl-flatten
 
-@function unfold($list) {
-    @return flatten($list);
+@function sl-unfold($list) {
+    @return sl-flatten($list);
 }

data/stylesheets/SassyLists/_insert-nth.scss

@@ -1,29 +1,31 @@
-// Adds $value at $index in $list
+// Adds `$value` at `$index` in `$list`.
 //
 // @ignore Documentation: http://sassylists.com/documentation/#insert-nth
 //
-// @requires is-true
+// @requires sl-is-true
 //
 // @param {List}    $list  - list to update
 // @param {Number}  $index - index to add
 // @param {*}       $value - value to add
 //
-// @throws List index $index is not a number for `insert-nth`.
-// @throws List index $index must be a non-zero integer for `insert-nth`.
+// @throws List index $index is not a number for `sl-insert-nth`.
+// @throws List index $index must be a non-zero integer for `sl-insert-nth`.
 //
-// @return {List | Bool}
+// @return {List | Null}
+
+@function sl-insert-nth($list, $index, $value) {
+  @if sl-missing-dependencies(sl-is-true) == true { @return null; }
 
-@function insert-nth($list, $index, $value) {
   $length: length($list);
 
   @if type-of($index) != number {
-    @warn "List index #{$index} is not a number for `insert-nth`.";
-    @return false;
+    @warn "List index #{$index} is not a number for `sl-insert-nth`.";
+    @return null;
   }
 
   @if $index < 1 {
-    @warn "List index #{$index} must be a non-zero integer for `insert-nth`.";
-    @return false;
+    @warn "List index #{$index} must be a non-zero integer for `sl-insert-nth`.";
+    @return null;
   }
 
   @if $index > $length {
@@ -34,7 +36,7 @@
 
   @for $i from 1 through $length {
     @if $i == $index {
-      @if is-true($value) {
+      @if sl-is-true($value) {
         $result: append($result, $value, list-separator($list));
       }
     }

data/stylesheets/SassyLists/_intersection.scss

@@ -1,15 +1,17 @@
-// Returns a list of shared value from $list and $lists minus duplicates
+// Returns a list of shared value from `$list` and `$lists` minus duplicates.
 //
 // @ignore Documentation: http://sassylists.com/documentation/#intersection
 //
-// @requires remove-duplicates
+// @requires sl-remove-duplicates
 //
 // @param {List}    $list  - first list
 // @param {ArgList} $lists - other lists
 //
 // @return {List}
 
-@function intersection($list, $lists...) {
+@function sl-intersection($list, $lists...) {
+  @if sl-missing-dependencies(sl-remove-duplicates) == true { @return null; }
+
   $result: $list;
 
   @each $list in $lists {
@@ -24,6 +26,6 @@
     $result: $temp;
   }
 
-  $result: remove-duplicates($result);
+  $result: sl-remove-duplicates($result);
   @return if(length($result) == 1, nth($result, 1), $result);
 }

data/stylesheets/SassyLists/_is-symmetrical.scss

@@ -1,19 +1,21 @@
-// Checks whether $list is symmetrical (one-level deep)
+// Checks whether `$list` is symmetrical.
 //
 // @ignore Documentation: http://sassylists.com/documentation/#is-symmetrical
 //
-// @requires reverse
+// @requires sl-reverse
 //
 // @param {List} $list - list to check
 //
 // @return {Bool}
 
-@function is-symmetrical($list) {
-  @return $list == reverse($list);
+@function sl-is-symmetrical($list) {
+  @if sl-missing-dependencies(sl-reverse) == true { @return null; }
+  
+  @return $list == sl-reverse($list);
 }
 
-// @alias is-symmetrical
+// @alias sl-is-symmetrical
 
-@function is-mirror($list) {
-  @return is-symmetrical($list);
+@function sl-is-mirror($list) {
+  @return sl-is-symmetrical($list);
 }

data/stylesheets/SassyLists/_last-index.scss

@@ -1,13 +1,13 @@
-// Returns last index of $value in $list
+// Returns last index of `$value` in `$list`.
 //
 // @ignore Documentation: http://sassylists.com/documentation/#last-index
 //
-// @param {List}    $list  - list to search
-// @param {*}       $value - value to be searched for
+// @param {List} $list  - list to search
+// @param {*}    $value - value to be searched for
 //
 // @return {Number | Null}
 
-@function last-index($list, $value) {
+@function sl-last-index($list, $value) {
   $length: length($list);
 
   @for $i from $length through 1 {

data/stylesheets/SassyLists/_last.scss

@@ -1,4 +1,4 @@
-// Returns last element of $list
+// Returns last element of `$list`.
 //
 // @ignore Documentation: http://sassylists.com/documentation/#last
 //
@@ -8,10 +8,10 @@
 //
 // @return {*}
 
-@function last($list) {
+@function sl-last($list) {
   @if length($list) == 0 {
     @warn "Cannot find last item of empty list.";
-    @return false;
+    @return null;
   }
 
   @return nth($list, -1);

data/stylesheets/SassyLists/_loop.scss

@@ -1,4 +1,6 @@
-// Shift indexes from $list of $value
+// Shift indexes from `$list` of `$value`.
+//
+// @author Ana Tudor
 //
 // @ignore Documentation: http://sassylists.com/documentation/#loop
 //
@@ -7,12 +9,12 @@
 //
 // @throws $value is not a number for `loop`.
 //
-// @return {List | Bool}
+// @return {List | Null}
 
-@function loop($list, $value: 1) {
+@function sl-loop($list, $value: 1) {
   @if type-of($value) != "number" {
-    @warn "#{$value} is not a number for `loop`.";
-    @return false;
+    @warn "#{$value} is not a number for `sl-loop`.";
+    @return null;
   }
 
   @if length($list) < 2 {
@@ -29,8 +31,8 @@
   @return $result;
 }
 
-// @alias shift-indexes
+// @alias sl-loop
 
-@function shift-indexes($list, $value: 1) {
-  @return loop($list, $value);
+@function sl-shift-indexes($list, $value: 1) {
+  @return sl-loop($list, $value);
 }

data/stylesheets/SassyLists/_prepend.scss

@@ -1,16 +1,18 @@
-// Adds $value as first index of $list
+// Adds `$value` as first index of `$list`.
 //
 // @ignore Documentation: http://sassylists.com/documentation/#prepend
 //
-// @requires is-true
+// @requires sl-is-true
 //
-// @param {List}    $list  - list to preprend value to
-// @param {*}       $value - value to prepend to the list
+// @param {List} $list  - list to preprend value to
+// @param {*}    $value - value to prepend to the list
 //
 // @return {List}
 
-@function prepend($list, $value) {
-  @if is-true($value) {
+@function sl-prepend($list, $value) {
+  @if missing-dependencies(sl-is-true) == true { @return null; }
+  
+  @if sl-is-true($value) {
     @return join($value, $list, list-separator($list));
   }
 

data/stylesheets/SassyLists/_purge.scss

@@ -1,18 +1,20 @@
-// Removes all false and null values from $list
+// Removes all false and null values from `$list`.
 //
 // @ignore Documentation: http://sassylists.com/documentation.html#purge
 //
-// @requires is-true
+// @requires sl-is-true
 //
 // @param {List} $list - list to purge
 //
 // @return {List}
 
-@function purge($list) {
+@function sl-purge($list) {
+  @if sl-missing-dependencies(sl-is-true) == true { @return null; }
+  
   $result: ();
 
   @each $item in $list {
-    @if is-true($item) {
+    @if sl-is-true($item) {
       $result: append($result, $item, list-separator($list));
     }
   }
@@ -20,8 +22,8 @@
   @return $result;
 }
 
-// @alias purge
+// @alias sl-purge
 
-@function clean($list) {
-  @return purge($list);
+@function sl-clean($list) {
+  @return sl-purge($list);
 }

data/stylesheets/SassyLists/_random-value.scss

@@ -1,4 +1,4 @@
-// Returns a random value of $list
+// Returns a random value of `$list`.
 //
 // @ignore Documentation: http://sassylists.com/documentation.html#random-value
 //
@@ -8,23 +8,23 @@
 //
 // @return {*}
 
-@function random-value($list) {
+@function sl-random-value($list) {
   @if length($list) == 0 {
     @warn "Cannot find a random value in an empty list.";
-    @return false;
+    @return null;
   }
 
-  @return nth($list, random(length($list)) + 1);
+  @return nth($list, random(length($list)));
 }
 
-// @alias random-value
+// @alias sl-random-value
 
-@function roll($list) {
-  @return random-value($list);
+@function sl-roll($list) {
+  @return sl-random-value($list);
 }
 
-// @alias random-value
+// @alias sl-random-value
 
-@function luck($list) {
-  @return random-value($list);
+@function sl-luck($list) {
+  @return sl-random-value($list);
 }