ListFunctions 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d656970f44fab99bfadc04718acd6f678578a68f
+  data.tar.gz: f4ec0ebdd9d18d9c7a62308e127513489a232605
+SHA512:
+  metadata.gz: 232e1c167919adb995faece9e23a37c2a1622809b1a6a948eefc7552057b9b3171b4d213b0f2b095bb4c99dd4948134cb281721da74d05a1edc6a2ac293252a8
+  data.tar.gz: c2837143ab92c7ee9b05fbe314c7754f882e8d68f59f03452761e3885f34839fffc2d0e681ecdaeac7fce2168ae70883a8678c816a1b0c62380a4d7f8306ea9a

data/lib/ListFunctions.rb

@@ -0,0 +1,30 @@
+# 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'
+
+# This tells Compass what your Compass extension is called, and where to find
+#  its files
+# Replace 'ListFunctions' with the name of your extension. Spaces allowed.
+extension_path = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+Compass::Frameworks.register('ListFunctions', :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
+#  Date is in the form of YYYY-MM-DD
+module ListFunctions
+  VERSION = "0.1"
+  DATE = "2013-10-06"
+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

data/stylesheets/ListFunctions/_chunk.scss

@@ -0,0 +1,32 @@
+/** 
+ * 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]
+ */
+@function chunk($list, $size) {
+  $n: ceil(length($list) / $size);
+  $temp-index: 0;
+  $result: ();
+
+  @for $i from 1 through $n {
+    $temp-list: ();
+
+    @for $j from 1 + $temp-index through $size + $temp-index {
+      @if $j <= length($list) {
+        $temp-list: append($temp-list, nth($list, $j));
+      }
+    }
+
+    $result: append($result, $temp-list);
+    $temp-index: $temp-index + $size;
+  }
+
+  @return $result;
+}

data/stylesheets/ListFunctions/_count-values.scss

@@ -0,0 +1,33 @@
+/** 
+ * 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]
+ */
+@function count-values($list) {
+  $keys   : ();
+  $counts : ();
+
+  @each $item in $list {
+    $index: index($keys, $item);
+
+    @if not $index {
+      $keys   : append($keys, $item);
+      $counts : append($counts, 1);
+    }
+
+    @else {
+      $count  : nth($counts, $index) + 1;
+      $counts : replace-nth($counts, $index, $count);
+    }
+  }
+
+  @return zip($keys, $counts);
+}

data/stylesheets/ListFunctions/_debug.scss

@@ -0,0 +1,34 @@
+/** 
+ * 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
+ * -------------------------------------------------------------------------------
+ * @return [String]
+ */
+@function debug($list) {
+  $result: #{"[ "};
+
+  @each $item in $list {
+
+    @if length($item) > 1 {
+      $result: $result#{debug($item)};
+    }
+
+    @else {
+      $result: $result#{$item};
+    }
+
+    @if index($list, $item) != length($list) {
+      $result: $result#{", "};
+    }
+
+  } 
+
+  $result: $result#{" ]"};
+
+  @return $result;
+}

data/stylesheets/ListFunctions/_first.scss

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

data/stylesheets/ListFunctions/_insert-nth.scss

@@ -0,0 +1,52 @@
+/** 
+ * 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
+ */
+@function insert-nth($list, $index, $value) {
+  $result: false;
+      
+  @if type-of($index) != number {
+    @warn "$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`";
+    @return $result;
+  }
+
+  @else if $index > length($list) {
+    @warn "List index is #{$index} but list is only #{length($list)} item long for `insert-nth'.";
+    @return $result;
+  }
+
+  @else {
+    $result: ();
+        
+    @for $i from 1 through length($list) {
+      @if $i == $index {
+        $result: append($result, $value);
+      }
+
+      $result: append($result, nth($list, $i));
+    }
+  }
+
+  @return purge($result);
+}

data/stylesheets/ListFunctions/_is-symmetrical.scss

@@ -0,0 +1,23 @@
+/**
+ * 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]
+ */
+@function is-symmetrical($list) {
+  $result: ();
+
+  @each $item in $list {
+    $result: append($result, $item, space); 
+  }
+      
+  @return $result == reverse($result); 
+}

data/stylesheets/ListFunctions/_last-index.scss

@@ -0,0 +1,24 @@
+/**
+ * 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
+ */
+@function last-index($list, $value) {
+  
+  @for $i from length($list) * -1 through -1 {
+    $i: abs($i);
+
+    @if nth($list, $i) == $value {
+      @return $i;
+    }
+    
+  }
+
+  @return null;
+}

data/stylesheets/ListFunctions/_last.scss

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

data/stylesheets/ListFunctions/_loop.scss

@@ -0,0 +1,21 @@
+/**
+ * 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]
+ */
+@function loop($list, $value: 1) {
+  $result: ();
+    
+  @for $i from 0 to length($list) {
+    $result: append($result, nth($list, ($i - $value) % length($list) + 1));
+  }
+  
+  @return $result;
+}

data/stylesheets/ListFunctions/_prepend.scss

@@ -0,0 +1,16 @@
+/**
+ * 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]
+ */
+@function prepend($list, $value) {
+  @return purge(join($value, $list));
+}

data/stylesheets/ListFunctions/_purge.scss

@@ -0,0 +1,21 @@
+/**
+ * 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]
+ */
+@function purge($list) {
+  $result: ();
+  
+  @each $item in $list {
+    @if $item != null and $item != false and $item != "" {
+      $result: append($result, $item);
+    }
+  }
+  
+  @return $result;
+}

data/stylesheets/ListFunctions/_remove-duplicates.scss

@@ -0,0 +1,30 @@
+/** 
+ * 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]
+ */
+@function remove-duplicates($list, $recursive: false) {
+  $result: ();
+  
+  @each $item in $list {
+
+    @if not index($result, $item) {
+      @if length($item) > 1 and $recursive {
+        $result: append($result, remove-duplicates($item, $recursive));
+      }
+      
+      @else {
+        $result: append($result, $item);
+      }
+    }
+
+  }
+  
+  @return $result;
+}

data/stylesheets/ListFunctions/_remove-nth.scss

@@ -0,0 +1,23 @@
+/**
+ * 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
+ */
+@function remove-nth($list, $index) {
+  @return replace-nth($list, $index, "");
+}

data/stylesheets/ListFunctions/_remove.scss

@@ -0,0 +1,19 @@
+/**
+ * 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]
+ */
+@function remove($list, $value, $recursive: false) {
+  @return replace($list, $value, "", $recursive);
+}

data/stylesheets/ListFunctions/_replace-nth.scss

@@ -0,0 +1,50 @@
+/**
+ * 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
+ */
+@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`.";
+    @return $result;
+  }
+
+  @else if $index == 0 {
+    @warn "List index 0 must be a non-zero integer for `replace-nth`/`remove-nth`.";
+    @return $result;
+  }
+      
+  @else if abs($index) > length($list) {
+    @warn "List index is #{$index} but list is only #{length($list)} item long for `replace-nth`/`remove-nth`.";
+    @return $result;
+  }
+
+  @else {
+    $result: ();
+    $index: if($index < 0, length($list) + $index + 1, $index);  
+
+    @for $i from 1 through length($list) {
+      $result: append($result, if($i == $index, $value, nth($list, $i)));
+    }
+  }
+ 
+  @return purge($result);
+}

data/stylesheets/ListFunctions/_replace.scss

@@ -0,0 +1,32 @@
+/** 
+ * 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]
+ */
+@function replace($list, $old-value, $new-value, $recursive: false) {
+  $result: ();
+
+  @each $item in $list {
+    @if length($item) > 1 and $recursive {
+      $result: append($result, replace($item, $old-value, $new-value, $recursive));
+    }
+
+    @else {
+      $result: append($result, if($item == $old-value, $new-value, $item));
+    }
+  }
+
+  @return purge($result);
+}

data/stylesheets/ListFunctions/_reverse.scss

@@ -0,0 +1,30 @@
+/**
+ * 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]
+ */
+@function reverse($list, $recursive: false) {
+  $result: ();
+
+  @for $i from length($list) * -1 through -1 {
+    $item: nth($list, abs($i));
+
+    @if length($item) > 1 and $recursive {
+      $result: append($result, reverse($item, $recursive));      
+    }
+
+    @else {
+      $result: append($result, $item);
+    }
+  }
+
+  @return $result;
+}

data/stylesheets/ListFunctions/_slice.scss

@@ -0,0 +1,60 @@
+/**
+ * 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
+ */ 
+@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`.";
+    @return $result;
+  }
+             
+  @else if $start > $end {
+    @warn "The start index has to be lesser than or equals to the end index for `slice`.";
+    @return $result;
+  }
+
+  @else if $start < 1 or $end < 1 {
+    @warn "List indexes must be non-zero integers for `slice`.";
+    @return $result;
+  }
+
+  @else if $start > length($list) {
+    @warn "List index is #{$start} but list is only #{length($list)} item 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`.";
+    @return $result;
+  }
+  
+  @else {
+    $result: ();
+                
+    @for $i from $start through $end {
+      $result: append($result, nth($list, $i));
+    }
+  }
+
+  @return $result;
+}

data/stylesheets/ListFunctions/_sum.scss

@@ -0,0 +1,32 @@
+/**
+ * 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]
+ */
+@function sum($list, $force: false) {
+  $result: 0;
+  
+  @each $item in $list {
+    @if type-of($item) == number {
+
+      @if $force and unit($item) {
+        $item: $item / ($item * 0 + 1);
+      }
+
+      @if unitless($item) {
+        $result: $result + $item;
+      }
+      
+    }
+  }
+  
+  @return $result;
+}

data/stylesheets/ListFunctions/_to-string.scss

@@ -0,0 +1,29 @@
+/**
+ * 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 $is-nested [Boolean] : strictly internal boolean for recursivity
+ * -------------------------------------------------------------------------------
+ * @return [String]
+ */
+@function to-string($list, $glue: '', $is-nested: false) {
+  $result: null;
+
+  @each $item in $list {
+    @if length($item) > 1 {
+      $result: $result#{to-string($item, $glue, true)};
+    }
+
+    @else {
+      $condition: index($list, item) != length($list) or $is-nested;
+      $result: if($condition, $result#{$item}#{$glue}, $result#{$item});
+    }
+  }
+
+  @return $result;
+}