ListFunctions 0.1

data/templates/project/sass/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/templates/project/sass/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/templates/project/sass/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/templates/project/sass/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/templates/project/sass/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/templates/project/sass/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/templates/project/sass/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/templates/project/sass/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/templates/project/sass/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/templates/project/sass/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/templates/project/sass/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/templates/project/sass/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;
+}

data/templates/project/sass/_ListFunctions.scss

@@ -0,0 +1,90 @@
+/* ------------------------------------------------------------------------------- *
+ * 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
+ *
+ * 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
+ *
+ * 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-ListFunctions/
+ * ------------------------------------------------------------------------------- */
+
+@import "ListFunctions/chunk";
+@import "ListFunctions/count-values";
+@import "ListFunctions/debug";
+@import "ListFunctions/first";
+@import "ListFunctions/insert-nth";
+@import "ListFunctions/is-symmetrical";
+@import "ListFunctions/last";
+@import "ListFunctions/last-index";
+@import "ListFunctions/loop";
+@import "ListFunctions/prepend";
+@import "ListFunctions/purge";
+@import "ListFunctions/remove";
+@import "ListFunctions/remove-duplicates";
+@import "ListFunctions/remove-nth";
+@import "ListFunctions/replace";
+@import "ListFunctions/replace-nth";
+@import "ListFunctions/reverse";
+@import "ListFunctions/slice";
+@import "ListFunctions/sum";
+@import "ListFunctions/to-string";

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: ListFunctions
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Hugo Giraudel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: compass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+description: Advanced Sass list functions
+email:
+- hugo.giraudel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ListFunctions.rb
+- stylesheets/ListFunctions/_chunk.scss
+- stylesheets/ListFunctions/_count-values.scss
+- stylesheets/ListFunctions/_debug.scss
+- stylesheets/ListFunctions/_first.scss
+- stylesheets/ListFunctions/_insert-nth.scss
+- stylesheets/ListFunctions/_is-symmetrical.scss
+- stylesheets/ListFunctions/_last-index.scss
+- stylesheets/ListFunctions/_last.scss
+- stylesheets/ListFunctions/_loop.scss
+- stylesheets/ListFunctions/_prepend.scss
+- stylesheets/ListFunctions/_purge.scss
+- stylesheets/ListFunctions/_remove-duplicates.scss
+- stylesheets/ListFunctions/_remove-nth.scss
+- stylesheets/ListFunctions/_remove.scss
+- stylesheets/ListFunctions/_replace-nth.scss
+- stylesheets/ListFunctions/_replace.scss
+- stylesheets/ListFunctions/_reverse.scss
+- stylesheets/ListFunctions/_slice.scss
+- stylesheets/ListFunctions/_sum.scss
+- stylesheets/ListFunctions/_to-string.scss
+- stylesheets/_ListFunctions.scss
+- templates/project/css/ListFunctions.css
+- templates/project/sass/ListFunctions/_chunk.scss
+- templates/project/sass/ListFunctions/_count-values.scss
+- templates/project/sass/ListFunctions/_debug.scss
+- templates/project/sass/ListFunctions/_first.scss
+- templates/project/sass/ListFunctions/_insert-nth.scss
+- templates/project/sass/ListFunctions/_is-symmetrical.scss
+- templates/project/sass/ListFunctions/_last-index.scss
+- templates/project/sass/ListFunctions/_last.scss
+- templates/project/sass/ListFunctions/_loop.scss
+- templates/project/sass/ListFunctions/_prepend.scss
+- templates/project/sass/ListFunctions/_purge.scss
+- templates/project/sass/ListFunctions/_remove-duplicates.scss
+- templates/project/sass/ListFunctions/_remove-nth.scss
+- templates/project/sass/ListFunctions/_remove.scss
+- templates/project/sass/ListFunctions/_replace-nth.scss
+- templates/project/sass/ListFunctions/_replace.scss
+- templates/project/sass/ListFunctions/_reverse.scss
+- templates/project/sass/ListFunctions/_slice.scss
+- templates/project/sass/ListFunctions/_sum.scss
+- templates/project/sass/ListFunctions/_to-string.scss
+- templates/project/sass/_ListFunctions.scss
+homepage: http://hugogiraudel.com/
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: ListFunctions
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Advanced Sass list functions
+test_files: []