ListFunctions 0.1 → 0.2

data/templates/project/sass/ListFunctions/_loop.scss

@@ -1,21 +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;
+/**
+ * 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/templates/project/sass/ListFunctions/_prepend.scss

@@ -1,16 +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));
+/**
+ * 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/templates/project/sass/ListFunctions/_purge.scss

@@ -1,21 +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;
+/**
+ * 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/templates/project/sass/ListFunctions/_remove-duplicates.scss

@@ -1,30 +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;
+/** 
+ * 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/templates/project/sass/ListFunctions/_remove-nth.scss

@@ -1,23 +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, "");
+/**
+ * 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/templates/project/sass/ListFunctions/_remove.scss

@@ -1,19 +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);
+/**
+ * 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/templates/project/sass/ListFunctions/_replace-nth.scss

@@ -1,50 +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);
+/**
+ * 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/templates/project/sass/ListFunctions/_replace.scss

@@ -1,32 +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);
+/** 
+ * 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/templates/project/sass/ListFunctions/_reverse.scss

@@ -1,30 +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;
+/**
+ * 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;
 }