compass-list-helpers 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTU0OGY4MTAzMWU2YWYyNDI0NzBkMjQ3ODA4NGJhYjM2OGM4NmU3ZA==
+  data.tar.gz: !binary |-
+    Y2RiNDJjMTNhNzA5OGIyZTRjZmNjNjFmOWNiODY0ZTdlY2I1NmViMg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OWYyYmQ3ZjJmM2YyODExYWZjNWQ5MjhmMWQ4YzA0ZGZjNDMyY2JlZTZiMDQ1
+    YjljNWY1YWJlODhjZjQ2OWFkNGU0MDcxMWJiNTg5MDgwNmRkYTdhZjFiMDE5
+    MDg3NzUyMDg4Y2M4Zjk5ZmFlYWZhMmU4YWMyNDgwOTJhZTA0ZGY=
+  data.tar.gz: !binary |-
+    YjA3YzI4NWFmZjJjNDUzMjlkMGFiYzRlNmNjZjM5NGRkOWZkNjFhNjRhM2Rm
+    OGZjYTAyZGNmZDAyMmYyNDllMzlkZmI0MGQyNmFmYzQ2ZmE1MzI3YzE0Mjdh
+    N2IxNDVkNzk3ZDk4NjViODg0NzZhYTZhODQyMzg4ODVjMGU4NTM=

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0 (2013-07-25)
+
+Initial working version.

data/README.md

@@ -0,0 +1,174 @@
+# Compass List Helpers
+
+List Helpers is a Compass extension providing useful list helper functions
+like: map, filter, reduce, every and some.
+
+The List Helpers are based on JavaScript's Array.prototype functions, but of
+course, adapted to Sass. Instead of passing in a function object in JS, in Sass
+you'd just pass in a function name, that will be called for each item in the
+list.
+
+## Installation
+
+Install List Helpers by:
+
+```bash
+$ gem install compass-list-helpers
+```
+
+Tell Compass you want to use List Helpers in your project's `config.rb`:
+
+```ruby
+require "list-helpers"
+```
+
+And import List Helpers into your stylesheet:
+
+```scss
+@import "list-helpers";
+```
+
+Not using Compass? Just copy and paste the contents of the `stylesheets` dir
+into your project.
+
+## Example usage
+
+As always, simple (silly) examples explain the rationale the best. It all
+starts with a list:
+
+```scss
+$my-awesome-colors: red, green, blue, yellow, blue, brown;
+$my-awesome-numbers: 1, 2, 3, 4, 10, 20, 30;
+```
+
+Then, we would define some functions to test each item against:
+
+```scss
+// `is-blue` returns true if $item is blue, else it returns false.
+@function is-blue($item) {
+	@if $item == blue {
+		@return true;
+	}
+	@return false;
+}
+
+// `add-numbers` adds two numbers, rocket science!
+@function add-numbers($a, $b) {
+	@return $a + $b;
+}
+
+// `double-up` doubles a number.
+@function double-up($a) {
+	@return $a * 2;
+}
+
+// `is-big-enough` returns true if $item is >= 10, else it returns false.
+@function is-big-enough($item) {
+	@if $item >= 10 {
+		@return true;
+	}
+	@return false;
+}
+```
+
+Now, if your using Sass 3.2 or lower, you need to define a `call` function. In
+Sass 3.3 a native `call` function is built-in, so there's no need for this poor
+man's solution:
+
+```scss
+// Note: only do this in Sass 3.2 or lower, in Sass 3.3 and higher there's no need for this.
+@function call($function, $arguments...) {
+	@if $function == 'is-blue' {
+		@return is-blue($arguments...);
+	}
+	@if $function == 'add-numbers' {
+		@return add-numbers($arguments...);
+	}
+	@if $function == 'double-up' {
+		@return double-up($arguments...);
+	}
+	@if $function == 'is-big-enough' {
+		@return is-big-enough($arguments...);
+	}
+}
+```
+
+Here comes the meat: now we can use the list helpers:
+
+```scss
+$the-blues: filter($my-awesome-colors, 'is-blue'); // Returns (blue, blue)
+$big-is-better: filter($my-awesome-numbers, 'is-big-enough'); // Returns (10, 20, 30)
+$all-blue: every($my-awesome-colors, 'is-blue'); // Returns false (not all items are blue)
+$some-blue: some($my-awesome-colors, 'is-blue'); // Returns true (at least one item is blue)
+$doubled: map($my-awesome-numbers, 'double-up'); // Returns (2, 4, 6, 8, 20, 40, 60)
+$grand-total: reduce($my-awesome-numbers, 'add-numbers'); // Returns 70
+```
+
+## List Helpers Functions
+
+List Helpers provides some useful functions:
+
+### `every($list, $callback)`
+
+Tests whether all items in the list pass the test implemented by the provided
+callback function.
+
+Every executes the provided callback function once for each item present in
+the list until it finds one where callback returns false. If such an item is
+found, the every method immediately returns false. Otherwise, if callback
+returned a true value for all items, every will return true.
+
+See the `every` [test cases](test/scss/tests/_every.scss) for more examples.
+
+### `filter($list, $callback)`
+
+Creates a new list with all items that pass the test implemented by the
+provided function.
+
+Filter calls a provided callback function once for each item in a list, and
+constructs a new list of all the values for which callback returns true.
+
+See the `filter` [test cases](test/scss/tests/_filter.scss) for more examples.
+
+### `map($list, $callback)`
+
+Creates a new list with the results of calling a provided function on every
+item in this list.
+
+Map calls a provided callback function once for each item in a list, in order,
+and constructs a new list from the results.
+
+See the `map` [test cases](test/scss/tests/_map.scss) for more examples.
+
+### `reduce($list, $callback, $initial: 0)`
+
+Apply a function against an accumulator and each item of the list (from
+left-to-right) as to reduce it to a single value.
+
+Reduce executes the callback function once for each item present in the list,
+passing it the result up until then and the current item in the list.
+
+The `$initial` argument is the value to use as the first argument to the first
+call of the callback. For example, if you're adding up the $my-awesome-numbers
+list of numbers from above, you can $initial to 10 in order to start adding at
+10 (so it will return 80).  
+In another example, if you're dealing with a list of lists you want to flatten,
+passing in an empty list as `$initial` will make sure the callback is properly
+called.  
+
+See the `reduce` [test cases](test/scss/tests/_reduce.scss) for more examples.
+
+### `some($list, $callback)`
+
+Tests whether some item in the list passes the test implemented by the provided
+callback function.
+
+Some executes the callback function once for each item present in the list
+until it finds one where callback returns a true value. If such an item is
+found, some immediately returns true. Otherwise, some returns false.
+
+See the `some` [test cases](test/scss/tests/_some.scss) for more examples.
+
+## License
+
+MIT License, see [LICENSE.txt](LICENSE.txt).

data/lib/list-helpers.rb

@@ -0,0 +1,4 @@
+require 'compass'
+
+extension_path = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+Compass::Frameworks.register('list-helpers', :path => extension_path)

data/stylesheets/_list-helpers.scss

@@ -0,0 +1,8 @@
+// ----------------------------------------------------------------------------
+// List Helpers
+
+@import "list-helpers/every";
+@import "list-helpers/filter";
+@import "list-helpers/map";
+@import "list-helpers/reduce";
+@import "list-helpers/some";

data/stylesheets/list-helpers/_every.scss

@@ -0,0 +1,22 @@
+// Function every
+// Tests whether all items in the list pass the test implemented by the
+// provided callback function.
+//
+// Every executes the provided callback function once for each item present in
+// the list until it finds one where callback returns false. If such an item is
+// found, the every method immediately returns false. Otherwise, if callback
+// returned a true value for all items, every will return true.
+//
+// @param $list {list} List of items
+// @param $callback {string} Name of the function to test for each item
+//
+// @return {boolean} Whether all items in the list pass the test
+//
+@function every($list, $callback) {
+	@each $item in $list {
+		@if call($callback, $item) == false {
+			@return false;
+		}
+	}
+	@return true;
+}

data/stylesheets/list-helpers/_filter.scss

@@ -0,0 +1,22 @@
+// Function filter
+// Creates a new list with all items that pass the test implemented by the
+// provided function.
+//
+// Filter calls a provided callback function once for each item in a list, and
+// constructs a new list of all the values for which callback returns true.
+//
+// @param $list {list} List of items
+// @param $callback {string} Name of the function to test for each item
+//
+// @return {list} The filtered list
+//
+@function filter($list, $callback) {
+	$new-list: ();
+	@each $item in $list {
+		$result: call($callback, $item);
+		@if $result == true {
+			$new-list: append($new-list, $item);
+		}
+	}
+	@return $new-list;
+}

data/stylesheets/list-helpers/_map.scss

@@ -0,0 +1,21 @@
+// Function map
+// Creates a new list with the results of calling a provided function on every
+// item in this list.
+//
+// Map calls a provided callback function once for each item in a list,
+// in order, and constructs a new list from the results.
+//
+// @param $list {list} List of items
+// @param $callback {string} Name of the function that produces an item of the
+//							 new list from an item of the current one.
+//
+// @return {list} The new list
+//
+@function map($list, $callback) {
+	$new-list: ();
+	@each $item in $list {
+		$item: call($callback, $item);
+		$new-list: append($new-list, $item);
+	}
+	@return $new-list;
+}

data/stylesheets/list-helpers/_reduce.scss

@@ -0,0 +1,21 @@
+// Function reduce
+// Apply a function against an accumulator and each item of the list
+// (from left-to-right) as to reduce it to a single value.
+//
+// Reduce executes the callback function once for each item present in the
+// list, passing it the result up until then and the current item in the list.
+//
+// @param $list {list} List of items
+// @param $callback {string} Name of the function to test for each item
+// @param $initial {literal} Value to use as the first argument to the first
+//							 call of the callback
+//
+// @return {list} The filtered list
+//
+@function reduce($list, $callback, $initial: 0) {
+	$result: $initial;
+	@for $i from 1 through length($list) {
+		$result: call($callback, $result, nth($list, $i));
+	}
+	@return $result;
+}

data/stylesheets/list-helpers/_some.scss

@@ -0,0 +1,21 @@
+// Function some
+// Tests whether some item in the list passes the test implemented by the
+// provided callback function.
+//
+// Some executes the callback function once for each item present in the list
+// until it finds one where callback returns a true value. If such an item is
+// found, some immediately returns true. Otherwise, some returns false.
+//
+// @param $list {list} List of items
+// @param $callback {string} Name of the function to test for each item
+//
+// @return {boolean} Whether some item in the list passes the test
+//
+@function some($list, $callback) {
+	@each $item in $list {
+		@if call($callback, $item) == true {
+			@return true;
+		}
+	}
+	@return false;
+}

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: compass-list-helpers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Leon de Rijke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-25 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: ! 'List Helpers is a Compass extension providing useful list helper functions
+  like: map, filter, reduce, every and some.'
+email:
+- leon@leonderijke.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- CHANGELOG.md
+- lib/list-helpers.rb
+- stylesheets/_list-helpers.scss
+- stylesheets/list-helpers/_every.scss
+- stylesheets/list-helpers/_filter.scss
+- stylesheets/list-helpers/_map.scss
+- stylesheets/list-helpers/_reduce.scss
+- stylesheets/list-helpers/_some.scss
+homepage: https://github.com/leonderijke/compass-list-helpers
+licenses:
+- MIT
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: Useful list helper functions for Sass, packaged as a Compass extension.
+test_files: []