SassyLists 0.2.4 → 0.3.0

data/CHANGELOG.md

@@ -1,5 +1,6 @@
 # Changelog
 
+* `0.3.0`: adding `contains()`, `flatten()`, `union()`
 * `0.2.4`: improving `debug()`
 * `0.2.3`: fixing important issues with comments
 * `0.2.2`: moving all comments to invisible

data/lib/SassyLists.rb

@@ -5,8 +5,8 @@ Compass::Frameworks.register('SassyLists', :path => extension_path)
 #  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.4"
-  DATE = "2013-11-01"
+  VERSION = "0.3.0"
+  DATE = "2013-11-04"
 end
 
 module Sass::Script::Functions

data/stylesheets/SassyLists/_chunk.scss

@@ -11,22 +11,22 @@
 // @return [List]
 
 @function chunk($list, $size) {
-  $n-lists: ceil(length($list) / $size);
-  $tmp-index: 0;
-  $result: ();
+    $n-lists: ceil(length($list) / $size);
+    $tmp-index: 0;
+    $result: ();
 
-  @for $i from 1 through $n-lists {
-    $tmp-list: ();
+    @for $i from 1 through $n-lists {
+        $tmp-list: ();
 
-    @for $j from 1 + $tmp-index through $size + $tmp-index {
-      @if $j <= length($list) {
-        $tmp-list: append($tmp-list, nth($list, $j));
-      }
-    }
+        @for $j from 1 + $tmp-index through $size + $tmp-index {
+            @if $j <= length($list) {
+                $tmp-list: append($tmp-list, nth($list, $j));
+            }
+        }
 
-    $result: append($result, $tmp-list);
-    $tmp-index: $tmp-index + $size;
-  }
+        $result: append($result, $tmp-list);
+        $tmp-index: $tmp-index + $size;
+    }
 
-  @return $result;
+    @return $result;
 }

data/stylesheets/SassyLists/_contains.scss

@@ -0,0 +1,15 @@
+// Returns whether $list contains $value
+// -------------------------------------------------------------------------------
+// @documentation http://sassylists.com/documentation/#contains
+// -------------------------------------------------------------------------------
+// @example chunk(a b c, a) => true
+// @example chunk(a b c, z) => false
+// -------------------------------------------------------------------------------
+// @param $list [List] : list
+// @param $value [Literal] : value to look for
+// -------------------------------------------------------------------------------
+// @return [Boolean]
+
+@function contains($list, $value) {
+	@return not not index($list, $value)
+}

data/stylesheets/SassyLists/_count-values.scss

@@ -12,22 +12,22 @@
 // @return [List]
 
 @function count-values($list) {
-  $keys   : ();
-  $counts : ();
+    $keys   : ();
+    $counts : ();
 
-  @each $item in $list {
-    $index: index($keys, $item);
+    @each $item in $list {
+        $index: index($keys, $item);
 
-    @if not $index {
-      $keys   : append($keys, $item);
-      $counts : append($counts, 1);
-    }
+        @if not $index {
+            $keys   : append($keys, $item);
+            $counts : append($counts, 1);
+        }
 
-    @else {
-      $count  : nth($counts, $index) + 1;
-      $counts : replace-nth($counts, $index, $count);
+        @else {
+            $count  : nth($counts, $index) + 1;
+            $counts : replace-nth($counts, $index, $count);
+        }
     }
-  }
 
-  @return zip($keys, $counts);
+    @return zip($keys, $counts);
 }

data/stylesheets/SassyLists/_first.scss

@@ -9,5 +9,5 @@
 // @return [Literal]
 
 @function first($list) {
-  @return nth($list, 1);
+	@return nth($list, 1);
 }

data/stylesheets/SassyLists/_flatten.scss

@@ -0,0 +1,27 @@
+// Turns multidimensional $list into a one-level list
+// -------------------------------------------------------------------------------
+// @documentation http://sassylists.com/documentation.html#flatten
+// -------------------------------------------------------------------------------
+// @example flatten(a b (c d (e f))) => a b c d e f
+// -------------------------------------------------------------------------------
+// @param $list [List] : list
+// -------------------------------------------------------------------------------
+// @return [List]
+
+@function flatten($list) {
+    $result: ();
+
+    @each $item in $list {
+        @if length($item) > 1 {
+            @each $i in flatten($item) {
+                $result: append($result, $i);
+            }
+        }
+
+        @else {
+            $result: append($result, $item);
+        }
+    }
+
+    @return $result;
+}

data/stylesheets/SassyLists/_insert-nth.scss

@@ -20,34 +20,34 @@
 // @return [List] | false
 
 @function insert-nth($list, $index, $value) {
-  $result: false;
-      
-  @if type-of($index) != number {
-    @warn "List index #{quote($index)} is not a number for `insert-nth`.";
-    @return $result;
-  }
-
-  @else if $index < 1 {
-    @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 #{quote($index)} but list is only #{length($list)} items 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));
+    $result: false;
+
+    @if type-of($index) != number {
+        @warn "List index #{quote($index)} is not a number for `insert-nth`.";
+        @return $result;
+    }
+
+    @else if $index < 1 {
+        @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 #{quote($index)} but list is only #{length($list)} items 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);
+    @return purge($result);
 }

data/stylesheets/SassyLists/_is-symmetrical.scss

@@ -13,5 +13,5 @@
 // @return [Boolean]
 
 @function is-symmetrical($list) {
-  @return reverse($list) == reverse(reverse($list));  
+	@return reverse($list) == reverse(reverse($list));  
 }

data/stylesheets/SassyLists/_last-index.scss

@@ -12,14 +12,11 @@
 
 @function last-index($list, $value) {
   
-  @for $i from length($list) * -1 through -1 {
-    $i: abs($i);
-
-    @if nth($list, $i) == $value {
-      @return $i;
-    }
-    
-  }
+	@for $i from length($list) * -1 through -1 {
+		@if nth($list, abs($i)) == $value {
+			@return abs($i);
+		}
+	}
 
   @return null;
 }

data/stylesheets/SassyLists/_last.scss

@@ -9,5 +9,5 @@
 // @return [Literal]
 
 @function last($list) {
-  @return nth($list, length($list));
+	@return nth($list, length($list));
 }

data/stylesheets/SassyLists/_loop.scss

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

data/stylesheets/SassyLists/_prepend.scss

@@ -13,5 +13,5 @@
 // @return [List]
 
 @function prepend($list, $value) {
-  @return purge(join($value, $list));
+	@return purge(join($value, $list));
 }

data/stylesheets/SassyLists/_purge.scss

@@ -10,13 +10,13 @@
 // @return [List]
 
 @function purge($list) {
-  $result: ();
-  
-  @each $item in $list {
-    @if $item != null and $item != false and $item != "" {
-      $result: append($result, $item);
-    }
-  }
-  
-  @return $result;
+	$result: ();
+
+	@each $item in $list {
+		@if $item != null and $item != false and $item != "" {
+			$result: append($result, $item);
+		}
+	}
+
+	@return $result;
 }

data/stylesheets/SassyLists/_random-value.scss

@@ -11,5 +11,5 @@
 // @return [Literal]
 
 @function random-value($list) {
-  @return nth($list, random(length($list)) + 1);
+	@return nth($list, random(length($list)) + 1);
 }

data/stylesheets/SassyLists/_remove-duplicates.scss

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

data/stylesheets/SassyLists/_remove-nth.scss

@@ -20,5 +20,5 @@
 // @return [List] | false
 
 @function remove-nth($list, $index) {
-  @return replace-nth($list, $index, "");
+	@return replace-nth($list, $index, "");
 }

data/stylesheets/SassyLists/_remove.scss

@@ -16,5 +16,5 @@
 // @return [List]
 
 @function remove($list, $value, $recursive: false) {
-  @return replace($list, $value, "", $recursive);
+	@return replace($list, $value, "", $recursive);
 }

data/stylesheets/SassyLists/_replace-nth.scss

@@ -21,31 +21,31 @@
 // @return [List] | false
 
 @function replace-nth($list, $index, $value) {
-  $result: false;
-      
-  @if type-of($index) != number {
-    @warn "List index #{quote($index)} is not a number for `replace-nth`/`remove-nth`.";
-    @return $result;
-  }
+    $result: false;
 
-  @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 #{quote($index)} but list is only #{length($list)} item long for `replace-nth`/`remove-nth`.";
-    @return $result;
-  }
+    @if type-of($index) != number {
+        @warn "List 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 {
-    $result: ();
-    $index: if($index < 0, length($list) + $index + 1, $index);  
+    @else if abs($index) > length($list) {
+        @warn "List index is #{quote($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)));
+        @for $i from 1 through length($list) {
+            $result: append($result, if($i == $index, $value, nth($list, $i)));
+        }
     }
-  }
- 
-  @return purge($result);
+
+    @return purge($result);
 }

data/stylesheets/SassyLists/_replace.scss

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

data/stylesheets/SassyLists/_reverse.scss

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

data/stylesheets/SassyLists/_slice.scss

@@ -22,40 +22,40 @@
 // @return [List] | false
 
 @function slice($list, $start: 1, $end: length($list)) {
-  $result: false;
-              
-  @if type-of($start) != number or type-of($end) != number {
-    @warn "List indexes #{quote($start)} and #{quote($end)} must be numbers for `slice`.";
-    @return $result;
-  }
-             
-  @else if $start > $end {
-    @warn "Start index is #{quote($start)} but has to be lesser than or equals to the end index (#{quote($end)}) for `slice`.";
-    @return $result;
-  }
+    $result: false;
+      
+    @if type-of($start) != number or type-of($end) != number {
+        @warn "List indexes #{quote($start)} and #{quote($end)} must be numbers for `slice`.";
+        @return $result;
+    }
+     
+    @else if $start > $end {
+        @warn "Start index is #{quote($start)} but has to be lesser than or equals to the end index (#{quote($end)}) 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 < 1 or $end < 1 {
+        @warn "List indexes must be non-zero integers for `slice`.";
+        @return $result;
+    }
 
-  @else if $start > length($list) {
-    @warn "Start index is #{quote($start)} but list is only #{length($list)} items long for `slice`.";
-    @return $result;
-  }
-             
-  @else if $end > length($list) {
-    @warn "End index is #{quote($end)} but list is only #{length($list)} items long for `slice`.";
-    @return $result;
-  }
-  
-  @else {
-    $result: ();
-                
-    @for $i from $start through $end {
-      $result: append($result, nth($list, $i));
+    @else if $start > length($list) {
+        @warn "Start index is #{quote($start)} but list is only #{length($list)} items long for `slice`.";
+        @return $result;
+    }
+     
+    @else if $end > length($list) {
+        @warn "End index is #{quote($end)} but list is only #{length($list)} items long for `slice`.";
+        @return $result;
     }
-  }
 
-  @return $result;
+    @else {
+        $result: ();
+            
+        @for $i from $start through $end {
+            $result: append($result, nth($list, $i));
+        }
+    }
+
+    @return $result;
 }

data/stylesheets/SassyLists/_sort.scss

@@ -15,48 +15,48 @@
 // @return [List]
 
 @function sort($list, $force: false) {
-  $result : nth($list, 1);
-  
-  @if length($list) > 1 {
+    $result : nth($list, 1);
 
-    @for $i from 2 through length($list) {
-      $item: nth($list, $i);
+    @if length($list) > 1 {
 
-      @if type-of($item) == number {
+        @for $i from 2 through length($list) {
+            $item: nth($list, $i);
 
-        @if unitless($item) and $force {
+            @if type-of($item) == number {
 
-          @if $item > last($result) {
-            $result: append($result, $item);
-          }
+                @if unitless($item) and $force {
 
-          @else {
-            $index: 0;
+                    @if $item > last($result) {
+                        $result: append($result, $item);
+                    }
 
-            @for $i from length($result) * -1 through -1 {
-              $i: abs($i);
-              
-              @if $item <= nth($result, $i) {
-                $index: $i;
-              }
-            }
+                    @else {
+                        $index: 0;
 
-            $result: insert-nth($result, $index, $item); 
-          }
+                        @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 unitless number found. Omitted.";
+                }
 
-      } 
+            } 
 
-      @else {
-        @warn "Not integer value found. Omitted.";
-      }
+            @else {
+                @warn "Not integer value found. Omitted.";
+            }
+        }
     }
-  }
-  
-  @return $result;
+
+    @return $result;
 }

data/stylesheets/SassyLists/_sum.scss

@@ -13,21 +13,21 @@
 // @return [Number]
 
 @function sum($list, $force: false) {
-  $result: 0;
-  
-  @each $item in $list {
-    @if type-of($item) == number {
+    $result: 0;
 
-      @if $force and unit($item) {
-        $item: $item / ($item * 0 + 1);
-      }
+    @each $item in $list {
+        @if type-of($item) == number {
 
-      @if unitless($item) {
-        $result: $result + $item;
-      }
-      
+            @if $force and unit($item) {
+                $item: $item / ($item * 0 + 1);
+            }
+
+            @if unitless($item) {
+                $result: $result + $item;
+            }
+
+        }
     }
-  }
-  
-  @return $result;
+
+    @return $result;
 }

data/stylesheets/SassyLists/_to-string.scss

@@ -13,18 +13,18 @@
 // @return [String]
 
 @function to-string($list, $glue: '', $root: true) {
-  $result: null;
+    $result: null;
 
-  @each $item in $list {
-    @if length($item) > 1 {
-      $result: $result#{to-string($item, $glue, false)};
-    }
+    @each $item in $list {
+        @if length($item) > 1 {
+            $result: $result#{to-string($item, $glue, false)};
+        }
 
-    @else {
-      $condition: index($list, $item) != length($list) or not $root;
-      $result: if($condition, $result#{$item}#{$glue}, $result#{$item});
+        @else {
+            $condition: index($list, $item) != length($list) or not $root;
+            $result: if($condition, $result#{$item}#{$glue}, $result#{$item});
+        }
     }
-  }
 
-  @return quote($result);
+    @return quote($result);
 }

data/stylesheets/SassyLists/_union.scss

@@ -0,0 +1,16 @@
+// Returns a list of shared values from $lists
+// -------------------------------------------------------------------------------
+// @documentation http://sassylists.com/documentation/#union
+// -------------------------------------------------------------------------------
+// @dependence `flatten()`
+// @dependence `remove-duplicates()`
+// -------------------------------------------------------------------------------
+// @example union((a b), (b c), (a b c d)) => a b c d
+// -------------------------------------------------------------------------------
+// @param $lists [ArgList] : lists
+// -------------------------------------------------------------------------------
+// @return [List]
+
+@function union($lists...) {
+	@return remove-duplicates(flatten($lists));
+}

data/stylesheets/_SassyLists.scss

@@ -7,9 +7,11 @@
 // -------------------------------------------------------------------------------
 
 @import "SassyLists/chunk";
+@import "SassyLists/contains";
 @import "SassyLists/count-values";
 @import "SassyLists/debug";
 @import "SassyLists/first";
+@import "SassyLists/flatten";
 @import "SassyLists/insert-nth";
 @import "SassyLists/is-symmetrical";
 @import "SassyLists/last";
@@ -27,4 +29,5 @@
 @import "SassyLists/slice";
 @import "SassyLists/sort";
 @import "SassyLists/sum";
-@import "SassyLists/to-string";
+@import "SassyLists/to-string";
+@import "SassyLists/union";

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: SassyLists
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-01 00:00:00.000000000 Z
+date: 2013-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sass
@@ -53,9 +53,11 @@ files:
 - CHANGELOG.md
 - lib/SassyLists.rb
 - stylesheets/SassyLists/_chunk.scss
+- stylesheets/SassyLists/_contains.scss
 - stylesheets/SassyLists/_count-values.scss
 - stylesheets/SassyLists/_debug.scss
 - stylesheets/SassyLists/_first.scss
+- stylesheets/SassyLists/_flatten.scss
 - stylesheets/SassyLists/_insert-nth.scss
 - stylesheets/SassyLists/_is-symmetrical.scss
 - stylesheets/SassyLists/_last-index.scss
@@ -74,6 +76,7 @@ files:
 - stylesheets/SassyLists/_sort.scss
 - stylesheets/SassyLists/_sum.scss
 - stylesheets/SassyLists/_to-string.scss
+- stylesheets/SassyLists/_union.scss
 - stylesheets/_SassyLists.scss
 homepage: http://sassylists.com/
 licenses: []