ListFunctions 0.1 → 0.2

data/lib/ListFunctions.rb

@@ -1,30 +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
-# 
+# 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.2"
+  DATE = "2013-10-16"
+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

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

@@ -1,33 +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);
+/** 
+ * 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

@@ -1,34 +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;
-}
+/** 
+ * 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 quote($result);
+}

data/stylesheets/ListFunctions/_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]
- */
-@function first($list) {
-  @return nth($list, 1);
+/**
+ * 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

@@ -1,52 +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);
+/** 
+ * 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

@@ -1,23 +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); 
+/**
+ * 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

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