SassyLists 0.2.1 → 0.2.2

data/CHANGELOG.md

@@ -1,5 +1,6 @@
 # Changelog
 
+* `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()`

data/lib/SassyLists.rb

@@ -1,32 +1,14 @@
-# All gems that are required for this extension to work should go here.
-# These are the requires you would normally put in your config.rb file
-# By default, you should always included Compass. Do not include your
-#  extension.
-require 'compass'
-
 require 'compass'
 extension_path = File.expand_path(File.join(File.dirname(__FILE__), ".."))
 Compass::Frameworks.register('SassyLists', :path => extension_path)
 
-# Version and date of version for your Compass extension.
-# Replace MyExtension with the name of your extension
-#  Letters, numbers, and underscores only
-#  Version is a number. If a version contains alphas, it will be created as
-#    a prerelease version
+#  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.2.1"
-  DATE = "2013-10-25"
+  VERSION = "0.2.2"
+  DATE = "2013-10-29"
 end
 
-# This is where any custom SassScript should be placed. The functions will be  
-#  available on require of your extension without the need for users to import
-#  any partials. Uncomment below.
-
-# module Sass::Script::Functions
-# 
-# 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)

data/stylesheets/SassyLists/_chunk.scss

@@ -1,31 +1,31 @@
-/** 
- * Chunk $list into $size large lists
- * -------------------------------------------------------------------------------
- * @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
- * @example chunk( a, 3 )               => a
- * -------------------------------------------------------------------------------
- * @param $list [List] : list
- * @param $size [Number] : length of lists
- * -------------------------------------------------------------------------------
- * @return [List]
- */
+// Chunks $list into $size large lists
+// -------------------------------------------------------------------------------
+// @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
+// -------------------------------------------------------------------------------
+// @return [List]
+
 @function chunk($list, $size) {
-  $n: ceil(length($list) / $size);
-  $temp-index: 0;
+  $n-lists: ceil(length($list) / $size);
+  $tmp-index: 0;
   $result: ();
 
-  @for $i from 1 through $n {
-    $temp-list: ();
+  @for $i from 1 through $n-lists {
+    $tmp-list: ();
 
-    @for $j from 1 + $temp-index through $size + $temp-index {
+    @for $j from 1 + $tmp-index through $size + $tmp-index {
       @if $j <= length($list) {
-        $temp-list: append($temp-list, nth($list, $j));
+        $tmp-list: append($tmp-list, nth($list, $j));
       }
     }
 
-    $result: append($result, $temp-list);
-    $temp-index: $temp-index + $size;
+    $result: append($result, $tmp-list);
+    $tmp-index: $tmp-index + $size;
   }
 
   @return $result;

data/stylesheets/SassyLists/_count-values.scss

@@ -1,16 +1,16 @@
-/** 
- * Count the number of occurrences of each value of $list
- * -------------------------------------------------------------------------------
- * @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
- * @example count-values( a ) => a 1
- * -------------------------------------------------------------------------------
- * @param $list [List] : list
- * -------------------------------------------------------------------------------
- * @return [List]
- */
+// Counts the number of occurrences of each value of $list
+// -------------------------------------------------------------------------------
+// @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]
+
 @function count-values($list) {
   $keys   : ();
   $counts : ();

data/stylesheets/SassyLists/_debug.scss

@@ -1,16 +1,16 @@
-/** 
- * Returns $list as a string
- * -------------------------------------------------------------------------------
- * @example debug( (a, b, c, d, e) ) => [ a, b, c, d, e ]
- * @example debug( (a b (c d e) ) )  => [ a, b, [ c, d, e ] ]
- * @example debug( a )               => [ a ]
- * -------------------------------------------------------------------------------
- * @param $list [List] : list
- * @param $type [Boolean] : enable/disable variables type
- * @param $root [Boolean] : strictly internal boolean for recursivity
- * -------------------------------------------------------------------------------
- * @return [String]
- */
+// Returns $list as a string
+// -------------------------------------------------------------------------------
+// @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 $type [Boolean] : enable/disable variables type
+// @param $root [Boolean] : strictly internal boolean for recursivity
+// -------------------------------------------------------------------------------
+// @return [String]
+
 @function debug($list, $type: true, $root: true) {
   @if length($list) == 1 {
     @return if($type, quote("(#{type-of($list)}) #{$list}"), quote("#{$list}"));
@@ -44,11 +44,11 @@
 }
 
 /** 
- * Mixin displaying clean debug
- * -------------------------------------------------------------------------------
- * @param $list [List] : list
- * @param $type [List] : enable/disable variables type
- */
+// Mixin displaying clean debug
+// -------------------------------------------------------------------------------
+// @param $list [List] : list
+// @param $type [List] : enable/disable variables type
+///
 @mixin debug($list, $type: true) {
   body:before {
     content: debug($list, $type)              !important;

data/stylesheets/SassyLists/_first.scss

@@ -1,13 +1,13 @@
-/**
- * Returns first element of $list
- * -------------------------------------------------------------------------------
- * @example first( (a, b, c) ) 	=> a
- * @example first( a ) 			=> a
- * -------------------------------------------------------------------------------
- * @param $list [List] : list
- * -------------------------------------------------------------------------------
- * @return [Literal]
- */
+// Returns first element of $list
+// -------------------------------------------------------------------------------
+// @documentation http://sassylists.com/documentation/#first
+// -------------------------------------------------------------------------------
+// @example first(a b c) => a
+// -------------------------------------------------------------------------------
+// @param $list [List] : list
+// -------------------------------------------------------------------------------
+// @return [Literal]
+
 @function first($list) {
   @return nth($list, 1);
 }

data/stylesheets/SassyLists/_insert-nth.scss

@@ -1,38 +1,39 @@
-/** 
- * Add $value at $index in $list
- * -------------------------------------------------------------------------------
- * @dependence `purge()`
- * -------------------------------------------------------------------------------
- * @example insert-nth( (a, b, c),  2, z ) => a, z, b, 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 ) => error
- * -------------------------------------------------------------------------------
- * @param $list [List] : list
- * @param $index [Number] : index to add
- * @param $value [Literal] : value to add
- * -------------------------------------------------------------------------------
- * @raise [Error] if $index isn't an integer
- * @raise [Error] if $index is strictly lesser than 1
- * @raise [Error] if $index is strictly greater than length of $list
- * -------------------------------------------------------------------------------
- * @return [List] | false
- */
+// Adds $value at $index in $list
+// -------------------------------------------------------------------------------
+// @documentation http://sassylists.com/documentation/#insert-nth
+// -------------------------------------------------------------------------------
+// @dependence `purge()`
+// -------------------------------------------------------------------------------
+// @example insert-nth(a b c,  2, z) => a, z, b, 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) => error
+// -------------------------------------------------------------------------------
+// @param $list [List] : list
+// @param $index [Number] : index to add
+// @param $value [Literal] : value to add
+// -------------------------------------------------------------------------------
+// @raise [Error] if $index isn't an integer
+// @raise [Error] if $index is strictly lesser than 1
+// @raise [Error] if $index is strictly greater than length of $list
+// -------------------------------------------------------------------------------
+// @return [List] | false
+
 @function insert-nth($list, $index, $value) {
   $result: false;
       
   @if type-of($index) != number {
-    @warn "$index: #{quote($index)} is not a number for `insert-nth`.";
+    @warn "List index #{quote($index)} is not a number for `insert-nth`.";
     @return $result;
   }
 
   @else if $index < 1 {
-    @warn "List index 0 must be a non-zero integer for `insert-nth`";
+    @warn "List index #{quote($index)} must be a non-zero integer for `insert-nth`";
     @return $result;
   }
 
   @else if $index > length($list) {
-    @warn "List index is #{$index} but list is only #{length($list)} item long for `insert-nth'.";
+    @warn "List index is #{quote($index)} but list is only #{length($list)} items long for `insert-nth'.";
     @return $result;
   }
 

data/stylesheets/SassyLists/_is-symmetrical.scss

@@ -1,17 +1,17 @@
-/**
- * Test if $list is symmetrical (one-level deep)
- * -------------------------------------------------------------------------------
- * @dependence `reverse()`
- * -------------------------------------------------------------------------------
- * @example is-symmetrical( (a, b, c, d, e) ) => false
- * @example is-symmetrical( (a, b, c, b, a) ) => true
- * @example is-symmetrical( a )               => true
- * @example is-symmetrical( a, b c d, a )     => true
- * -------------------------------------------------------------------------------
- * @param $list [List] : list
- * -------------------------------------------------------------------------------
- * @return [Boolean]
- */
+// Checks whether $list is symmetrical (one-level deep)
+// -------------------------------------------------------------------------------
+// @documentation http://sassylists.com/documentation/#is-symmetrical
+// -------------------------------------------------------------------------------
+// @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) {
   @return reverse($list) == reverse(reverse($list));  
 }

data/stylesheets/SassyLists/_last-index.scss

@@ -1,17 +1,18 @@
-/**
- * Returns last index of $value in $list
- * -------------------------------------------------------------------------------
- * @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
- */
+// Returns last index of $value in $list
+// -------------------------------------------------------------------------------
+// @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) {
   
-  @for $i from length($list) * -1 through -1 {
+  @for $i from length($list)// -1 through -1 {
     $i: abs($i);
 
     @if nth($list, $i) == $value {

data/stylesheets/SassyLists/_last.scss

@@ -1,13 +1,13 @@
-/**
- * Returns last element of $list
- * -------------------------------------------------------------------------------
- * @example last( (a, b, c) ) => c
- * @example last( a )         => a
- * -------------------------------------------------------------------------------
- * @param $list [List] : list
- * -------------------------------------------------------------------------------
- * @return [Literal]
- */
+// Returns last element of $list
+// -------------------------------------------------------------------------------
+// @documentation http://sassylists.com/documentation/#last
+// -------------------------------------------------------------------------------
+// @example last(a b c) => c
+// -------------------------------------------------------------------------------
+// @param $list [List] : list
+// -------------------------------------------------------------------------------
+// @return [Literal]
+
 @function last($list) {
   @return nth($list, length($list));
 }

data/stylesheets/SassyLists/_loop.scss

@@ -1,15 +1,16 @@
-/**
- * Shift indexes from $list of $value
- * -------------------------------------------------------------------------------
- * @example loop( (a, b, c, d, e) )     => e, a, b, c, d
- * @example loop( (a, b, c, d, e),  2 ) => d, e, a, b, c
- * @example loop( (a, b, c, d, e), -2 ) => c, d, e, a, b
- * -------------------------------------------------------------------------------
- * @param $list [List] : list
- * @param $value [Number] : number of position between old and new indexes
- * -------------------------------------------------------------------------------
- * @return [List]
- */
+// Shift indexes from $list of $value
+// -------------------------------------------------------------------------------
+// @documentation http://sassylists.com/documentation/#loop
+// -------------------------------------------------------------------------------
+// @example loop(a b c d e)     => e, a, b, c, d
+// @example loop(a b c d e,  2) => d, e, a, b, c
+// @example loop(a b c d e, -2) => c, d, e, a, b
+// -------------------------------------------------------------------------------
+// @param $list [List] : list
+// @param $value [Number] : number of position between old and new indexes
+// -------------------------------------------------------------------------------
+// @return [List]
+
 @function loop($list, $value: 1) {
   $result: ();
     

data/stylesheets/SassyLists/_prepend.scss

@@ -1,16 +1,17 @@
-/**
- * Add $value as first index of $list
- * -------------------------------------------------------------------------------
- * @dependence `purge()`
- * -------------------------------------------------------------------------------
- * @example prepend( (a, b, c), z )   => z, a, b, c
- * @example prepend( (a, b, c), y z ) => y z, a, b, c
- * -------------------------------------------------------------------------------
- * @param $list [List] : list
- * @param $value [Literal] : value to prepend to the list
- * -------------------------------------------------------------------------------
- * @return [List]
- */
+// Adds $value as first index of $list
+// -------------------------------------------------------------------------------
+// @documentation http://sassylists.com/documentation/#prepend
+// -------------------------------------------------------------------------------
+// @dependence `purge()`
+// -------------------------------------------------------------------------------
+// @example prepend(a b c, z)   => z, a, b, c
+// @example prepend(a b c, y z) => y z, a, b, c
+// -------------------------------------------------------------------------------
+// @param $list [List] : list
+// @param $value [Literal] : value to prepend to the list
+// -------------------------------------------------------------------------------
+// @return [List]
+
 @function prepend($list, $value) {
   @return purge(join($value, $list));
 }

data/stylesheets/SassyLists/_purge.scss

@@ -1,13 +1,14 @@
-/**
- * Remove all false and null values from $list
- * -------------------------------------------------------------------------------
- * @example purge( (a, null, b, false, c, null) ) => a, b, c
- * @example purge( (a, b, c) )                    => a, b, c
- * -------------------------------------------------------------------------------
- * @param $list [List] : list
- * -------------------------------------------------------------------------------
- * @return [List]
- */
+// Removes all false and null values from $list
+// -------------------------------------------------------------------------------
+// @documentation http://sassylists.com/documentation.html#purge
+// -------------------------------------------------------------------------------
+// @example purge(a null b false c) => a, b, c
+// @example purge(a b c)            => a, b, c
+// -------------------------------------------------------------------------------
+// @param $list [List] : list
+// -------------------------------------------------------------------------------
+// @return [List]
+
 @function purge($list) {
   $result: ();
   

data/stylesheets/SassyLists/_random-value.scss

@@ -1,14 +1,15 @@
-/** 
- * Returns a random value of $list
- * -------------------------------------------------------------------------------
- * @dependence `rand` (Ruby)
- * -------------------------------------------------------------------------------
- * @example random-value( (a, b, c, d, e) ) => c
- * -------------------------------------------------------------------------------
- * @param $list [List] : List
- * -------------------------------------------------------------------------------
- * @return [Literal]
- */
+// Returns a random value of $list
+// -------------------------------------------------------------------------------
+// @documentation http://sassylists.com/documentation.html#random-value
+// -------------------------------------------------------------------------------
+// @dependence `rand` (Ruby)
+// -------------------------------------------------------------------------------
+// @example random-value(a b c d e) => c
+// -------------------------------------------------------------------------------
+// @param $list [List] : List
+// -------------------------------------------------------------------------------
+// @return [Literal]
+
 @function random-value($list) {
   @return nth($list, random(length($list)) + 1);
 }

data/stylesheets/SassyLists/_remove-duplicates.scss

@@ -1,14 +1,15 @@
-/** 
- * Remove duplicate values from $list
- * -------------------------------------------------------------------------------
- * @example remove-duplicates( (a, b, a, c, b, d, c, e) ) => a, b, c, d, e
- * @example remove-duplicates( (a, b, (c, c, c)) )        => a, b, c
- * -------------------------------------------------------------------------------
- * @param $list [List] : list
- * @param $recursive [Boolean] : enable / disable recursivity
- * -------------------------------------------------------------------------------
- * @return [List]
- */
+// Removes duplicate values from $list
+// -------------------------------------------------------------------------------
+// @documentation http://sassylists.com/documentation/#remove-duplicates
+// -------------------------------------------------------------------------------
+// @example remove-duplicates(a b a c b d c e)   => a, b, c, d, e
+// @example remove-duplicates(a b (c c c), true) => a, b, c
+// -------------------------------------------------------------------------------
+// @param $list [List] : list
+// @param $recursive [Boolean] : enable / disable recursivity
+// -------------------------------------------------------------------------------
+// @return [List]
+
 @function remove-duplicates($list, $recursive: false) {
   $result: ();
   

data/stylesheets/SassyLists/_remove-nth.scss

@@ -1,23 +1,24 @@
-/**
- * Remove value from $list at index $index
- * -------------------------------------------------------------------------------
- * @dependence `replace-nth()`
- * -------------------------------------------------------------------------------
- * @example remove-nth( (a, b, c),   2 ) => a, c
- * @example remove-nth( (a, b, c),   0 ) => error
- * @example remove-nth( (a, b, c),  -1 ) => a, b
- * @example remove-nth( (a, b, c),  10 ) => error
- * @example remove-nth( (a, b, c), -10 ) => error
- * -------------------------------------------------------------------------------
- * @param $list [List] : list
- * @param $index [Number] : index to remove
- * -------------------------------------------------------------------------------
- * @raise [Error] if $index isn't an integer
- * @raise [Error] if $index is 0
- * @raise [Error] if abs value of $index is strictly greater then length of $list
- * -------------------------------------------------------------------------------
- * @return [List] | false
- */
+// Removes value from $list at index $index
+// -------------------------------------------------------------------------------
+// @documentation http://sassylists.com/documentation/#remove-nth
+// -------------------------------------------------------------------------------
+// @dependence `replace-nth()`
+// -------------------------------------------------------------------------------
+// @example remove-nth(a b c,   2) => a, c
+// @example remove-nth(a b c,   0) => error
+// @example remove-nth(a b c,  -1) => a, b
+// @example remove-nth(a b c,  10) => error
+// @example remove-nth(a b c, -10) => error
+// -------------------------------------------------------------------------------
+// @param $list [List] : list
+// @param $index [Number] : index to remove
+// -------------------------------------------------------------------------------
+// @raise [Error] if $index isn't an integer
+// @raise [Error] if $index is 0
+// @raise [Error] if abs value of $index is strictly greater then length of $list
+// -------------------------------------------------------------------------------
+// @return [List] | false
+
 @function remove-nth($list, $index) {
   @return replace-nth($list, $index, "");
 }

data/stylesheets/SassyLists/_remove.scss

@@ -1,19 +1,20 @@
-/**
- * Remove value(s) $value from $list
- * -------------------------------------------------------------------------------
- * @dependence `replace()`
- * -------------------------------------------------------------------------------
- * @example remove( (a, b, c),   b )       => a, c
- * @example remove( (a, b, c),   z )       => a, b, c
- * @example remove( (a, b, c b), b )       => a, c b
- * @example remove( (a, b, c b), b, true ) => a, c
- * -------------------------------------------------------------------------------
- * @param $list [List] : list
- * @param $value [Literal] : value to remove
- * @param $recursive [Boolean] : enable / disable recursivity
- * -------------------------------------------------------------------------------
- * @return [List]
- */
+// Removes value(s) $value from $list
+// -------------------------------------------------------------------------------
+// @documentation http://sassylists.com/documentation/#remove
+// -------------------------------------------------------------------------------
+// @dependence `replace()`
+// -------------------------------------------------------------------------------
+// @example remove(a b c,   b)       => a, c
+// @example remove(a b c,   z)       => a, b, c
+// @example remove(a b c b, b)       => a, c b
+// @example remove(a b c b, b, true) => a, c
+// -------------------------------------------------------------------------------
+// @param $list [List] : list
+// @param $value [Literal] : value to remove
+// @param $recursive [Boolean] : enable / disable recursivity
+// -------------------------------------------------------------------------------
+// @return [List]
+
 @function remove($list, $value, $recursive: false) {
   @return replace($list, $value, "", $recursive);
 }

data/stylesheets/SassyLists/_replace-nth.scss

@@ -1,29 +1,30 @@
-/**
- * Replace value at $index from $list by $value
- * -------------------------------------------------------------------------------
- * @dependence `purge()`
- * -------------------------------------------------------------------------------
- * @example replace-nth( (a, b, c),   2, z ) => a, z, c
- * @example replace-nth( (a, b, c),   0, z ) => error
- * @example replace-nth( (a, b, c),  -1, z ) => a, b, z
- * @example replace-nth( (a, b, c),  10, z ) => error
- * @example replace-nth( (a, b, c), -10, z ) => error
- * -------------------------------------------------------------------------------
- * @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
- */
+// Replaces value at $index from $list by $value
+// -------------------------------------------------------------------------------
+// @documentation http://sassylists.com/documentation/#replace-nth
+// -------------------------------------------------------------------------------
+// @dependence `purge()`
+// -------------------------------------------------------------------------------
+// @example replace-nth(a b c,   2, z) => a, z, c
+// @example replace-nth(a b c,   0, z) => error
+// @example replace-nth(a b c,  10, z) => error
+// @example replace-nth(a b c,  -1, z) => a, b, z
+// @example replace-nth(a b c, -10, z) => error
+// -------------------------------------------------------------------------------
+// @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) {
   $result: false;
       
   @if type-of($index) != number {
-    @warn "$index: #{quote($index)} is not a number for `replace-nth`/`remove-nth`.";
+    @warn "List index #{quote($index)} is not a number for `replace-nth`/`remove-nth`.";
     @return $result;
   }
 
@@ -33,7 +34,7 @@
   }
       
   @else if abs($index) > length($list) {
-    @warn "List index is #{$index} but list is only #{length($list)} item long for `replace-nth`/`remove-nth`.";
+    @warn "List index is #{quote($index)} but list is only #{length($list)} item long for `replace-nth`/`remove-nth`.";
     @return $result;
   }
 

data/stylesheets/SassyLists/_replace.scss

@@ -1,20 +1,21 @@
-/** 
- * Replace $old-value by $new-value in $list
- * -------------------------------------------------------------------------------
- * @dependence `purge()`
- * -------------------------------------------------------------------------------
- * @example replace( (a, b, c), b, z )         => a, z, c
- * @example replace( (a, b, c), y, z )         => a, b, c
- * @example replace( (a, b, c a), a, z )       => z, b, c z
- * @example replace( (a, b, c a), a, z, true ) => z, b, c z
- * -------------------------------------------------------------------------------
- * @param $list [List] : list
- * @param $old-value [Literal] : value to replace
- * @param $new-value [Literal] : new value for $old-value
- * @param $recursive [Boolean] : enable / disable recursivity
- * -------------------------------------------------------------------------------
- * @return [List]
- */
+// Replaces $old-value by $new-value in $list
+// -------------------------------------------------------------------------------
+// @documentation http://sassylists.com/documentation.html#replace
+// -------------------------------------------------------------------------------
+// @dependence `purge()`
+// -------------------------------------------------------------------------------
+// @example replace( (a, b, c), b, z )         => a, z, c
+// @example replace( (a, b, c), y, z )         => a, b, c
+// @example replace( (a, b, c a), a, z )       => z, b, c z
+// @example replace( (a, b, c a), a, z, true ) => z, b, c z
+// -------------------------------------------------------------------------------
+// @param $list [List] : list
+// @param $old-value [Literal] : value to replace
+// @param $new-value [Literal] : new value for $old-value
+// @param $recursive [Boolean] : enable / disable recursivity
+// -------------------------------------------------------------------------------
+// @return [List]
+
 @function replace($list, $old-value, $new-value, $recursive: false) {
   $result: ();
 

data/stylesheets/SassyLists/_reverse.scss

@@ -1,20 +1,20 @@
-/**
- * Reverses the order of $list
- * -------------------------------------------------------------------------------
- * @example reverse( (a, b, c) )         => c, b, a
- * @example reverse( (a, b, c a) )       => c a, b, a
- * @example reverse( (a, b, c a), true ) => a c, b, a
- * @example reverse( a )                 => a
- * -------------------------------------------------------------------------------
- * @param $list [List] : list
- * @param $recursive [Boolean] : enable / disable recursivity
- * -------------------------------------------------------------------------------
- * @return [List]
- */
+// Reverses the order of $list
+// -------------------------------------------------------------------------------
+// @documentation http://sassylists.com/documentation/#reverse
+// -------------------------------------------------------------------------------
+// @example reverse(a b c)           => c, b, a
+// @example reverse(a b (c a))       => c a, b, a
+// @example reverse(a b (c a), true) => a c, b, a
+// -------------------------------------------------------------------------------
+// @param $list [List] : list
+// @param $recursive [Boolean] : enable / disable recursivity
+// -------------------------------------------------------------------------------
+// @return [List]
+
 @function reverse($list, $recursive: false) {
   $result: ();
 
-  @for $i from length($list) * -1 through -1 {
+  @for $i from length($list)// -1 through -1 {
     $item: nth($list, abs($i));
 
     @if length($item) > 1 and $recursive {

data/stylesheets/SassyLists/_slice.scss

@@ -1,35 +1,36 @@
-/**
- * Slices $list between $start and $end
- * -------------------------------------------------------------------------------
- * @example slice( (a, b, c, d),  2, 3 ) => b, c
- * @example slice( (a, b, c, d),  3, 2 ) => error
- * @example slice( (a, b, c, d),  3, 5 ) => error
- * @example slice( (a, b, c, d), -1, 3 ) => error
- * @example slice( (a, b, c, d),  0, 3 ) => error
- * @example slice( (a, b, c, d),  3, 3 ) => c
- * -------------------------------------------------------------------------------
- * @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
- */ 
+// Slices $list between $start and $end
+// -------------------------------------------------------------------------------
+// @documentation http://sassylists.com/documentation/#slice
+// -------------------------------------------------------------------------------
+// @example slice(a b c d,  2, 3) => b, c
+// @example slice(a b c d,  3, 2) => error
+// @example slice(a b c d,  3, 5) => error
+// @example slice(a b c d, -1, 3) => error
+// @example slice(a b c d,  0, 3) => error
+// @example slice(a b c d,  3, 3) => c
+// -------------------------------------------------------------------------------
+// @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)) {
   $result: false;
               
   @if type-of($start) != number or type-of($end) != number {
-    @warn "Either $start or $end are not a number for `slice`.";
+    @warn "List indexes #{quote($start)} and #{quote($end)} must be numbers for `slice`.";
     @return $result;
   }
              
   @else if $start > $end {
-    @warn "The start index has to be lesser than or equals to the end index for `slice`.";
+    @warn "Start index is #{quote($start)} but has to be lesser than or equals to the end index (#{quote($end)}) for `slice`.";
     @return $result;
   }
 
@@ -39,12 +40,12 @@
   }
 
   @else if $start > length($list) {
-    @warn "List index is #{$start} but list is only #{length($list)} item long for `slice`.";
+    @warn "Start index is #{quote($start)} but list is only #{length($list)} items long for `slice`.";
     @return $result;
   }
              
   @else if $end > length($list) {
-    @warn "List index is #{$end} but list is only #{length($list)} item long for `slice`.";
+    @warn "End index is #{quote($end)} but list is only #{length($list)} items long for `slice`.";
     @return $result;
   }
   

data/stylesheets/SassyLists/_sort.scss

@@ -1,45 +1,57 @@
-/** 
- * Sort numeric values of $list
- * -------------------------------------------------------------------------------
- * @dependence `last()`
- * @dependence `insert-nth()`
- * -------------------------------------------------------------------------------
- * @example sort( (5, 12, 4.7, 6, 69, 6) )            => 4.7, 5, 6, 6, 12, 69
- * @example sort( (5, 12, 4.7, "8", 6, 14px, 69, 6) ) => 4.7, 5, 6, 6, 12, 69
- * @example sort( 1 )                                 => 1
- * -------------------------------------------------------------------------------
- * @param $list [List] : list
- * -------------------------------------------------------------------------------
- * @raise [Warning] if not unitless number found
- * -------------------------------------------------------------------------------
- * @return [List]
- */
+// Sorts numeric values of $list
+// -------------------------------------------------------------------------------
+// @documentation http://sassylists.com/documentation/#sort
+// -------------------------------------------------------------------------------
+// @dependence `last()`
+// @dependence `insert-nth()`
+// -------------------------------------------------------------------------------
+// @example sort(5 12 4.7 6 69 6)          => 4.7, 5, 6, 6, 12, 69
+// @example sort(5 12 4.7 "8" 6 14px 69 6) => 4.7, 5, 6, 6, 12, 69
+// -------------------------------------------------------------------------------
+// @param $list [List] : list
+// -------------------------------------------------------------------------------
+// @raise [Warning] if not unitless number found
+// -------------------------------------------------------------------------------
+// @return [List]
+
 @function sort($list, $force: false) {
   $result : nth($list, 1);
   
   @if length($list) > 1 {
+
     @for $i from 2 through length($list) {
       $item: nth($list, $i);
+
       @if type-of($item) == number {
+
         @if unitless($item) and $force {
+
           @if $item > last($result) {
             $result: append($result, $item);
           }
+
           @else {
             $index: 0;
+
             @for $i from length($result)*-1 through -1 {
               $i: abs($i);
+              
               @if $item <= nth($result, $i) {
                 $index: $i;
               }
             }
+
             $result: insert-nth($result, $index, $item); 
           }
+
         }
+
         @else {
           @warn "Not unitless number found. Omitted.";
         }
+
       } 
+
       @else {
         @warn "Not integer value found. Omitted.";
       }

data/stylesheets/SassyLists/_sum.scss

@@ -1,16 +1,17 @@
-/**
- * Sum up all unitless values in $list
- * -------------------------------------------------------------------------------
- * @example sum( (1 2 3 4 5) )         => 15
- * @example sum( (1 a 2 b 3) )         => 6
- * @example sum( (10px 3em 5%) )       => 0
- * @example sum( (10px 3em 5%, true) ) => 18
- * -------------------------------------------------------------------------------
- * @param $list [List] : list
- * @param $force [Boolean] : enable / disable parseInt
- * -------------------------------------------------------------------------------
- * @return [Number]
- */
+// Sums up all unitless values in $list
+// -------------------------------------------------------------------------------
+// @documentation http://sassylists.com/documentation/#sum
+// -------------------------------------------------------------------------------
+// @example sum(1 2 3 4 5)         => 15
+// @example sum(1 a 2 b 3)         => 6
+// @example sum(10px 3em 5%)       => 0
+// @example sum(10px 3em 5%, true) => 18
+// -------------------------------------------------------------------------------
+// @param $list [List] : list
+// @param $force [Boolean] : enable / disable parseInt
+// -------------------------------------------------------------------------------
+// @return [Number]
+
 @function sum($list, $force: false) {
   $result: 0;
   
@@ -18,7 +19,7 @@
     @if type-of($item) == number {
 
       @if $force and unit($item) {
-        $item: $item / ($item * 0 + 1);
+        $item: $item / ($item// 0 + 1);
       }
 
       @if unitless($item) {

data/stylesheets/SassyLists/_to-string.scss

@@ -1,16 +1,17 @@
-/**
- * Joins all elements of $list with $glue
- * -------------------------------------------------------------------------------
- * @example to-string( (a, b, c) )      => abc
- * @example to-string( (a, b, c), '-' ) => a-b-c
- * @example to-string( (a, b c, d) )    => abcd
- * -------------------------------------------------------------------------------
- * @param $list [List] : list
- * @param $glue [String] : value to use as a join string
- * @param $root [Boolean] : strictly internal boolean for recursivity
- * -------------------------------------------------------------------------------
- * @return [String]
- */
+// Joins all elements of $list with $glue
+// -------------------------------------------------------------------------------
+// @documentation http://sassylists.com/documentation/#to-string
+// -------------------------------------------------------------------------------
+// @example to-string(a b c)      => abc
+// @example to-string(a (b c) d)  => abcd
+// @example to-string(a b c, '-') => a-b-c
+// -------------------------------------------------------------------------------
+// @param $list [List] : list
+// @param $glue [String] : value to use as a join string
+// @param $root [Boolean] : strictly internal boolean for recursivity
+// -------------------------------------------------------------------------------
+// @return [String]
+
 @function to-string($list, $glue: '', $root: true) {
   $result: null;
 

data/stylesheets/_SassyLists.scss

@@ -1,78 +1,10 @@
-/* ------------------------------------------------------------------------------- *
- * SassyLists - A couple of advanced Sass list functions
- * ------------------------------------------------------------------------------- *
- *
- * chunk($list, $size)
- * Chunk $list into $size large lists
- *
- * count-values($list)
- * Count the number of occurrences of each value of $list
- *
- * debug($list)
- * Returns $list as a string
- *
- * first($list)
- * Return first element of $list
- *
- * insert-nth($list, $index, $value)
- * Add $value at $index in $list
- *
- * is-symmetrical($list)
- * Check if $list is symmetrical
- * 
- * last($list)
- * Return last element of $list
- *
- * last-index($list, $value)
- * Return last index of $value in $list
- *
- * loop($list, $value: 1)
- * Shift indexes from $list of $value
- *
- * prepend($list, $value)
- * Add $value as first index of $list
- *
- * purge($list)
- * Remove all false and null values from $list
- *
- * random-value($list)
- * Return random value from $list
- *
- * remove($list, $value, $recursive: false)
- * Remove value(s) $value from $list
- *
- * remove-duplicates($list, $recursive: false)
- * Remove duplicate values from $list
- *
- * remove-nth($list, $index)
- * Remove value from $list at index $index
- *
- * replace($list, $old-value, $new-value, $recursive: false)
- * Replace $old-value by $new-value in $list
- *
- * replace-nth($list, $index, $value)
- * Replace value at $index from $list by $value
- *
- * reverse($list, $recursive: false)
- * Reverse the order of $list
- *
- * slice($list, $start: 1, $end: length($list))
- * Slice $list between $start and $end
- *
- * sort($list)
- * Sort all numeric values in $list
- *
- * sum($list, $force: false)
- * Sum up all unitless values in $list
- *
- * to-string($list, $glue: '', $is-nested: false)
- * Join all elements of $list with $glue
- *
- * ------------------------------------------------------------------------------- *
- * CodePen (SCSS): http://codepen.io/HugoGiraudel/pen/loAgq
- * CodePen (Sass): http://codepen.io/HugoGiraudel/pen/BskrE
- * Repository: https://github.com/Team-Sass/Sass-list-functions/
- * ------------------------------------------------------------------------------- */
+// -------------------------------------------------------------------------------
+// SassyLists - A couple of advanced Sass list functions
+// -------------------------------------------------------------------------------
+// Official site: http://sassylists.com/
+// CodePen: http://codepen.io/HugoGiraudel/pen/loAgq
+// Repository: https://github.com/Team-Sass/SassyLists/
+// -------------------------------------------------------------------------------
 
 @import "SassyLists/chunk";
 @import "SassyLists/count-values";

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: SassyLists
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-25 00:00:00.000000000 Z
+date: 2013-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sass
@@ -50,7 +50,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- readme.md
 - CHANGELOG.md
 - lib/SassyLists.rb
 - stylesheets/SassyLists/_chunk.scss
@@ -76,7 +75,7 @@ files:
 - stylesheets/SassyLists/_sum.scss
 - stylesheets/SassyLists/_to-string.scss
 - stylesheets/_SassyLists.scss
-homepage: https://github.com/Team-Sass/Sass-list-functions
+homepage: http://sassylists.com/
 licenses: []
 post_install_message: 
 rdoc_options: []

data/readme.md

@@ -1,30 +0,0 @@
-SassyLists - Advanced Sass list functions
-=========================================
-
-Here are a couple of advanced Sass (SCSS) list functions you may or may not need in your projects. Including:
-
-* `chunk()`: chunk list into size large lists
-* `count-values()`: count the number of occurrences of each value of list
-* `debug()`: returns list as a string
-* `first()`: return first item in list
-* `insert-nth()`: insert value at index
-* `is-symmetrical()`: check if list is symmetrical
-* `last()`: return last item in list
-* `last-index()`: return last index of value in list
-* `loop()`: shift indexes in list
-* `prepend()`: prepend value to list
-* `purge()`: remove all `false` and `null` values from list
-* `remove()`: remove value in list
-* `remove-duplicates()`: remove duplicate values from list
-* `remove-nth()`: remove value at index
-* `replace()`: replace value in list
-* `replace-nth()`: replace value at index
-* `reverse()`: reverse list
-* `slice()`: slice list
-* `sort()`: sort list
-* `sum()`: sum all unitless values in list
-* `to-string()`: cast list as string (JS `.join()`)
-
-Some functions depend on other functions. If you include functions individually, make sure to check for these dependencies in their respective docs.
-
-If you ever need to use them in one of your pen at [CodePen](http://codepen.io), just link to http://codepen.io/HugoGiraudel/pen/loAgq as an extra CSS resource. You'll have instant access to all functions.