sass-aleksi 0.1.2

data/stylesheets/aleksi/maps/_map-merge-deep.scss

@@ -0,0 +1,54 @@
+// =============================================================================
+// =ALEKSI - MAP-MERGE-DEEP
+// =============================================================================
+////
+//// @group aleksi-maps
+//// @author [Yoannis Jamar](http://yoannis.me)
+
+@import "sassy-maps";
+@import "aleksi/general/throw";
+@import "aleksi/maps/is-map";
+
+// =map-merge-deep( $map-a, $map-b )
+// -----------------------------------------------------------------------------
+/// Deeply merges two maps together. Works with nested maps.
+///
+/// @param {map} $map-a - The first map to merge.
+/// @param {map} $map-b - The map to merge into `$map-a`.
+///
+/// @return {map} - A new map with nested maps merged
+/// @throw Error if `$map-a` or `$map-b` is not a map
+///
+/// @example scss
+///   $foo: map-merge-deep('a': 10, 'b': ('ba': false, 'bb': 'bar'), 'c': 'foo'), ('a': 20, 'b': ('bb': 'baz', 'bc': 'wiz')));
+///     // => ('a': 20, 'b': ('ba': false, 'bb': 'baz', 'bc': 'wiz'), 'c': 'foo')
+///
+/// @access public
+/// @since 0.1.0
+
+@function map-merge-deep( $map-a, $map-b )
+{
+  @if not is-map($map-a) {
+    @return throw-error('map-merge-deep():: `$map-a` must be a map. Was #{inspect($map-a)}.');
+  }
+
+  @if not is-map($map-b) {
+    @return throw-error('map-merge-deep():: `$map-b` must be a map. Was #{inspect($map-b)}.');
+  }
+
+  $res: $map-a;
+
+  @each $key, $value in $map-b {
+    // if we are merging a nested map
+    // ('map-get()' will return'null' if $res does not have $key so it
+    // is safe not to verify)
+    @if type-of($value) == 'map' and type-of(map-get($res, $key)) == 'map' {
+      // merge nested maps before setting the value
+      $value: map-merge-deep(map-get($res, $key), $value);
+    }
+
+    $res: map-set($res, $key, $value);
+  }
+
+  @return $res;
+}

data/stylesheets/aleksi/maps/_map-select.scss

@@ -0,0 +1,56 @@
+// =============================================================================
+// =ALEKSI - MAP-SELECT
+// =============================================================================
+////
+//// @group aleksi-maps
+//// @author [Yoannis Jamar](http://yoannis.me)
+
+@import "sassy-maps/map-set";
+@import "aleksi/general/throw";
+@import "aleksi/maps/is-map";
+
+// =map-select( $map, $keys )
+// -----------------------------------------------------------------------------
+/// Reduces a map's by selecting some of its keys only.
+///
+/// @param {map} $map - The map to reduce.
+/// @param {list} $keys - The keys to keep in the resulting map.
+///
+/// @return {map} - `$map` with only the keys present in `$keys`.
+/// @throw Error if `$map` is not a map.
+///
+/// @example scss
+///   $foo: map-select( ('a': 'foo', 'b': 'bar', 'c': 'baz'), 'a' 'c');
+///     // => ('a': 'foo', 'c': 'baz')
+///
+/// @access public
+/// @since 0.1.0
+
+@function map-select-keys( $map, $keys )
+{
+  @if not is-map($map) {
+    @return throw-error('map-select():: $map must be a map, was #{inspect($map)}.');
+  }
+
+  $res: ();
+
+  @each $key, $value in $map {
+    @if index($keys, $key) {
+      $res: map-set($res, $key, $value);
+    }
+  }
+
+  @return $res;
+}
+
+// =map-select( $map, $keys )
+// -----------------------------------------------------------------------------
+/// @alias map-select-keys
+///
+/// @access public
+/// @since 0.1.0
+
+@function map-select( $map, $keys )
+{
+  @return map-select-keys( $map, $keys );
+}

data/stylesheets/aleksi/maps/_map-sort.scss

@@ -0,0 +1,125 @@
+// =============================================================================
+// =ALEKSI - MAP-SORT
+// =============================================================================
+////
+//// @group aleksi-maps
+//// @author [Yoannis Jamar](http://yoannis.me)
+
+@import "SassyLists";
+@import "sassy-maps";
+@import "aleksi/general/throw";
+@import "aleksi/general/default-to";
+@import "aleksi/maps/is-map";
+
+// =map-sort-values( $map[, $order ])
+// -----------------------------------------------------------------------------
+/// Orders a map's keys according to a given, ordered list of values. If no
+/// order is specified, the alphabetic order of the map's values will be used.
+/// **Note**: items with a value that is not in the ordered list will be added
+/// at the end of the resulting map, in the same order as in the original map.
+///
+/// @param {type|...} $name [default] - Description
+///
+/// @return {type|...} - Description
+/// @throw Error if `$map` is not a map
+///
+/// @access public
+/// @since 0.1.0
+///
+/// @todo Manage duplicated values.
+
+@function map-sort-values( $map, $order: null )
+{
+  @if not is-map($map) {
+    @return throw-error('map-sort-keys():: $map must be a map, was #{inspect($map)}.');
+  }
+
+  $keys: map-keys($map);
+  $values: map-values($map);
+  $order: default-to($order, sl-sort($values));
+
+  @each $val in $order {
+    $i: index($values, $val);
+
+    @if index($values, $val) {
+      $res: map-set( $res, nth($keys, $i), $val);
+      $keys: sl-remove-nth($keys, $i);
+    }
+  }
+
+  // include leftovers at the end
+  @each $key in $keys {
+    $res: map-set($res, $key, map-get($map, $key));
+  }
+
+  @return $res;
+}
+
+// =map-sort-keys( $map[, $order ])
+// -----------------------------------------------------------------------------
+/// Orders a map's keys according to a given, ordered list of keys. If no order
+/// is specified, the keys will be ordered alphabetically.
+/// **Note**: keys that are not in the ordered list will be added at the end of
+/// the resulting map, in the same order as in the original map.
+///
+/// @param {map} $map - The map to order.
+/// @param {list} $order (alphabetic order) - An ordered list of key names.
+///
+/// @return {type|...} - The map with it's keys in the same order as `$order`.
+/// @throw Error if `$map` is not a map.
+/// @throw Error if `$order` is not a list, a string, null or false.
+///
+/// @access public
+/// @since 0.1.0
+
+@function map-sort-keys( $map, $order: null )
+{
+  @if not is-map($map) {
+    @return throw-error('map-sort-keys():: $map must be a map, was #{inspect($map)}.');
+  }
+
+  // allow lists and single strings for `$order`
+  @if not is-of-type($order, 'list' 'string' 'null') {
+    @return throw-error('map-sort-keys():: $order must be a list or a single string. Was #{inspect($order)}.');
+  }
+
+  $keys: map-keys($map);
+  $order: default-to($order, sl-sort($keys));
+  $res: ();
+
+  @each $key in $order {
+    @if index($keys, $key) {
+      $res: map-set($res, $key, map-get($map, $key));
+    }
+  }
+
+  // include leftovers at the end
+  @if length($res) < length($map) {
+    $res: map-merge($res, $map);
+  }
+
+  @return $res;
+}
+
+// =map-sort( $map[, $order ])
+// -----------------------------------------------------------------------------
+/// @alias map-sort-keys
+///
+/// @access public
+/// @since 0.1.0
+
+@function map-sort($map, $order: null)
+{
+  @if type-of($map) != 'map' {
+    @return throw-error('map-sort():: $map must be a map, was #{inspect($map)}.');
+  }
+
+  $keys: sl-sort(map-keys($map));
+  $res: ();
+
+  @each $key in $keys {
+    $res: map-set($res, $key, map-get($map, $key));
+  }
+
+  @return $res;
+}

data/stylesheets/aleksi/maps/_map-unique.scss

@@ -0,0 +1,46 @@
+// =============================================================================
+// =ALEKSI - MAP-UNIQUE
+// =============================================================================
+////
+//// @group aleksi-maps
+//// @author [Yoannis Jamar](http://yoannis.me)
+
+@import "SassyLists";
+@import "sassy-maps";
+@import "aleksi/general/throw";
+@import "aleksi/maps/is-map";
+
+// =map-unique( $map )
+// -----------------------------------------------------------------------------
+/// removes all duplicate values inside a map.
+///
+/// @param {map} $map - The map from which to remove duplicate values
+///
+/// @return {map} - New map without duplicates
+/// @throw Error if `$map` is not a map.
+///
+/// @example scss
+///   $foo: map-unique('a': 'foo', 'b': 'bar', 'c': 'foo', 'd': 'baz');
+///     // => ('a': 'foo', 'b': 'bar', 'd': 'baz')
+///
+/// @access public
+/// @since 0.1.0
+
+@function map-unique( $map )
+{
+  @if not is-map($map) {
+    @return throw-error('map-unique():: $map must be a map, was #{inspect($map)}.');
+  }
+
+  $unique-values: ();
+  $res: ();
+
+  @each $key, $val in $map {
+    @if not sl-contain($unique-values, $val) {
+      $unique-values: append($unique-values, $val);
+      $res: map-set($res, $key, $val);
+    }
+  }
+
+  @return $res;
+}

data/stylesheets/aleksi/maps/_map-walk.scss

@@ -0,0 +1,79 @@
+// =============================================================================
+// =ALEKSI - MAP-WALK
+// =============================================================================
+////
+//// @group aleksi-maps
+//// @author [Yoannis Jamar](http://yoannis.me)
+
+@import "sassy-maps";
+@import "aleksi/general/throw";
+@import "aleksi/maps/is-map";
+
+// =map-walk( $map, $func[, $args... ])
+// -----------------------------------------------------------------------------
+/// Applies the given function to all values inside a map. The map's current
+/// value is passed as first argument to the function.
+///
+/// @param {map} $map - The map to walk over.
+/// @param {string} $func - The name of the function to apply to each value.
+/// @param {arglist} $args... - Additional arguments passed to '$func`.
+///
+/// @return {map} - The map with modified values.
+/// @throw Error `$map` must be a map.
+///
+/// @example scss
+///   $foo: map-walk(('foo': 'bar', 'bar': 'baz'), 'to-upper-case');
+///     // => ('foo': 'BAR', 'bar': 'BAZ')
+///
+/// @access public
+/// @since 0.1.0
+
+@function map-walk( $map, $func, $args... )
+{
+  @if not is-map($map) {
+    $e: throw-error('map-walk():: $map must be a map, was #{inspect($map)}.');
+  }
+
+  $res: ();
+
+  @each $key, $val in $map {
+    $new: if( length($args) == 0, call($func, $val), call($func, $val, $args...) );
+    $res: map-set($res, $key, $new);
+  }
+
+  @return $res;
+}
+
+// =map-walk-keys( $map, $func[, $args... ])
+// -----------------------------------------------------------------------------
+/// Applies the given function to all keys inside a map. The map's current
+/// key is passed as first argument to the function.
+///
+/// @param {map} $map - The map to walk over.
+/// @param {string} $func - The name of the function to apply to each key.
+/// @param {arglist} $args... - Additional arguments passed to '$func`.
+///
+/// @return {map} - The map with modified keys.
+/// @throw Error `$map` must be a map.
+///
+/// @example scss
+///   $foo: map-walk(('foo': 'bar', 'bar': 'baz'), 'to-upper-case');
+///     // => ('FOO': 'bar', 'BAR': 'baz')
+///
+/// @access public
+/// @since 0.1.0
+
+@function map-walk-keys( $map, $func, $args... )
+{
+  @if not is-map($map) {
+    $e: throw-error('map-walk-keys():: $map must be a map, was #{inspect($map)}.');
+  }
+
+  $res: ();
+
+  @each $key, $val in $map {
+    $res: map-set($res, call($func, $key, $args...), $val);
+  }
+
+  @return $res;
+}

data/stylesheets/aleksi/maps/_map-zip.scss

@@ -0,0 +1,64 @@
+// =============================================================================
+// =ALEKSI - MAP_ZIP
+// =============================================================================
+////
+//// @group aleksi-maps
+//// @author [Yoannis Jamar](http://yoannis.me)
+
+@import "aleksi/general/throw";
+@import "aleksi/lists/wrap-in-list";
+@import "aleksi/maps/is-map";
+
+// =map-zip( $keys, $values)
+// -----------------------------------------------------------------------------
+/// Builds a map based on a list of keys, and a list of values. Equivalent of
+/// sass's native `zip` function but for maps.
+/// **Note**: in case `$keys` and `$values` are not the same length, additional
+/// values will be discarded and it will throw a warning.
+/// @author [Hugo Giraudel](http://hugogiraudel.com)
+///
+/// @param {list} $keys - The keys for the built map.
+/// @param {list} $values - The values for the built map, in same order.
+///
+/// @return {map} - A new map pairing `$keys` with `$values`.
+///
+/// @example scss
+///   $foo: map-zip('a' 'b' 'c', 10 true 'foo');
+///     // => ('a': 10, 'b': true, 'c': 'foo')
+///   $bar: map-zip('a' 'b' 'c', 10 'foo');
+///     // => ('a': 10, 'b': 'foo')
+///   $baz: map-zip('a', 'b', 10 true 'foo');
+///     // => ('a': 10, 'b': true)
+///
+/// @see http://sass-lang.com/documentation/Sass/Script/Functions.html#zip-instance_method
+///
+/// @access public
+/// @since 0.1.0
+
+@function map-zip($keys, $values)
+{
+  // allow creating a single-item map with a nested map
+  @if is-map($values) and length($keys) == 1 {
+    $values: wrap-in-list($values);
+  }
+
+  $l-keys: length($keys);
+  $l-values: length($values);
+  $min: min($l-keys, $l-values);
+  $map: ();
+
+  @if $l-keys != $l-values {
+    $e: throw-warning('map-zip():: Received #{$l-keys} key(s) for #{$l-values} value(s). Resulting map will only have #{$min} pairs.');
+  }
+
+  // return empty map if one of the passed lists is empty
+  @if $min == 0 {
+    @return $map;
+  }
+
+  @for $i from 1 through $min {
+    $map: map-merge($map, (nth($keys, $i): nth($values, $i)));
+  }
+
+  @return $map;
+}

data/stylesheets/aleksi/math/_add.scss

@@ -0,0 +1,66 @@
+// =============================================================================
+// =ALEKSI - ADD
+// =============================================================================
+////
+//// @group aleksi-math
+//// @author [Yoannis Jamar](http://yoannis.me)
+
+@import "SassyLists";
+@import "aleksi/general/throw";
+@import "aleksi/general/is-of-type";
+
+// =add( $terms... )
+// -----------------------------------------------------------------------------
+/// Calculates the sum between two or more numbers. Usefull when relying on
+/// `call()`, `walk()` or `apply()` for mathematical operations.
+/// **Note**: passing more then 2 arguments will add them successively.
+/// **Note**: if one of the terms is not a number, it will return `null`.
+///
+/// @param {arglist} $terms - The operators in the addition.
+///
+/// @return {number|null} - The sum resulting from adding `$terms`.
+/// @throw Warning if one of the terms is not a number.
+///
+/// @example scss
+///   $foo: add(10, 5);
+///     // => 15
+///   $bar: add(10, 'hello')
+///     // => null
+///   $baz: add(10 5, 3)
+///     // => null
+///   $wiz: add(10, 5, 3)
+///     // => 18
+///
+/// @access public
+/// @since 0.1.0
+
+@function add( $terms... )
+{
+  @if not sl-every($terms, 'is-of-type', 'number') {
+    @return throw-warning('add():: all $terms must be numbers — returning null.');
+  }
+
+  @if length($terms) < 2 {
+    @return thow-error('add():: wrong number of arguments, 1 instead of 2 or more.');
+  }
+
+  $sum: nth($terms, 1);
+
+  @each $term in sl-slice($terms, 2) {
+    $sum: $sum + $term;
+  }
+
+  @return $sum;
+}
+
+// =sum( $terms... )
+// -----------------------------------------------------------------------------
+/// @alias add
+///
+/// @access public
+/// @since 0.1.0
+
+@function sum( $terms... )
+{
+  @return add($terms...);
+}

data/stylesheets/aleksi/math/_divide.scss

@@ -0,0 +1,66 @@
+// =============================================================================
+// =ALEKSI - DIVIDE
+// =============================================================================
+////
+//// @group aleksi-math
+//// @author [Yoannis Jamar](http://yoannis.me)
+
+@import "SassyLists";
+@import "aleksi/general/throw";
+@import "aleksi/general/is-of-type";
+
+// =divide( $terms... )
+// -----------------------------------------------------------------------------
+/// Calculates the quotient between two or more numbers. Usefull when relying on
+/// `call()`, `walk()` or `apply()` for mathematical operations.
+/// **Note**: passing more then 2 arguments will divide them successively.
+/// **Note**: if one of the terms is not a number, it will return `null`.
+///
+/// @param {arglist} $terms - The operators in the division.
+///
+/// @return {number|null} - The quotient resulting from dividing `$terms`.
+/// @throw Warning if one of the terms is not a number.
+///
+/// @example scss
+///   $foo: divide(10, 5);
+///     // => 50
+///   $bar: divide(10, 'hello')
+///     // => null
+///   $baz: divide(10 5, 3)
+///     // => null
+///   $wiz: divide(10, 5, 3)
+///     // => 0.66667
+///
+/// @access public
+/// @since 0.1.0
+
+@function divide( $terms... )
+{
+  @if not sl-every($terms, 'is-of-type', 'number') {
+    @return throw-warning('divide():: all $terms must be numbers — returning null.');
+  }
+
+  @if length($terms) < 2 {
+    @return thow-error('divide():: wrong number of arguments, 1 instead of 2 or more.');
+  }
+
+  $quot: nth($terms, 1);
+
+  @each $term in sl-slice($terms, 2) {
+    $quot: $quot / $term;
+  }
+
+  @return $quot;
+}
+
+// =div( $terms... )
+// -----------------------------------------------------------------------------
+/// @alias divide
+///
+/// @access public
+/// @since 0.1.0
+
+@function div( $terms... )
+{
+  @return divide( $terms... );
+}

data/stylesheets/aleksi/math/_multiply.scss

@@ -0,0 +1,66 @@
+// =============================================================================
+// =ALEKSI - MULTIPLY
+// =============================================================================
+////
+//// @group aleksi-math
+//// @author [Yoannis Jamar](http://yoannis.me)
+
+@import "SassyLists";
+@import "aleksi/general/throw";
+@import "aleksi/general/is-of-type";
+
+// =multiply( $terms... )
+// -----------------------------------------------------------------------------
+/// Calculates the product between two or more numbers. Usefull when relying on
+/// `call()`, `walk()` or `apply()` for mathematical operations.
+/// **Note**: passing more then 2 arguments will multiply them successively.
+/// **Note**: if one of the terms is not a number, it will return `null`.
+///
+/// @param {arglist} $terms - The operators in the multiplication.
+///
+/// @return {number|null} - The product resulting from multiplying `$terms`.
+/// @throw Warning if one of the terms is not a number.
+///
+/// @example scss
+///   $foo: multiply(10, 5);
+///     // => 50
+///   $bar: multiply(10, 'hello')
+///     // => null
+///   $baz: multiply(10 5, 3)
+///     // => null
+///   $wiz: multiply(10, 5, 3)
+///     // => 150
+///
+/// @access public
+/// @since 0.1.0
+
+@function multiply( $terms... )
+{
+  @if not sl-every($terms, 'is-of-type', 'number') {
+    @return throw-warning('multiply():: all $terms must be numbers — returning null.');
+  }
+
+  @if length($terms) < 2 {
+    @return thow-error('multiply():: wrong number of arguments, 1 instead of 2 or more.');
+  }
+
+  $prod: nth($terms, 1);
+
+  @each $term in sl-slice($terms, 2) {
+    $prod: $prod * $term;
+  }
+
+  @return $prod;
+}
+
+// =mult( $terms... )
+// -----------------------------------------------------------------------------
+/// @alias multiply
+///
+/// @access public
+/// @since 0.1.0
+
+@function mult( $terms... )
+{
+  @return multiply( $terms... );
+}