SassyCast 1.1.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fe251b1a6ffe01552a24e60f604cb0db3410350
-  data.tar.gz: 4daa38ecdf06c9ccc8e1efef82e48b6730a905c2
+  metadata.gz: 0c1556381a6b01b0f805f92e2d09cc42a1ae1fe7
+  data.tar.gz: 415763f8aaf4c3f34c41ea65508a4461be8630f5
 SHA512:
-  metadata.gz: d382f9bdc42cf267841cc0ae619b1aa0835516c3ac33cb0196e745791f0c66b291ef7e34a25339eb8d0c9d12f5e6fd1fca4ff9fb4a53d4e6460561ca3cd4a109
-  data.tar.gz: ca3bfe36dbbb6e1c2f700f780c86d9cfcdc1fe75e746d62e61c501573915c94318f44b203d4e6b7c2fb69b4704452176df607ed97156c0e9d57d5ec2a9745540
+  metadata.gz: 56999187e7973b5c2b447db8ecf5819d8c1c155db67a03e78c8664a67bb9344b93efbc8d62836d081e13d0c354842310558d771cac291bb0d37d13766c25fdde
+  data.tar.gz: 56117204566f9c156200f644d72a54b5dd0fb52ff4231c564175b3e28021ed3c701175d02b1a7880edb6450185ab553d434d39ecb6d23aa0567961eccdd28906

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+* `2.0.0`: 
+  * No more distinction between public and private APIs. The public API (`to-*` functions) remains unchanged, but the private one (`_sc-to-*` functions) has been removed.
+  * A strict mode toggle has been added (`$sc-strict-mode`): SassyCast will throw when not able to convert to color / number, or return a default value with a warning in non-strict mode.
+  * Default value for color casting in non-strict mode is now `transparent`, not `null`, to make conversion always return the expected type.
+  * Default value for color casting in non-strict mode can be configured through `$sc-non-strict-default-color` variable.
+  * Default value for number casting in non-strict mode can be configured through `$sc-non-strict-default-number` variable.
+  * `$keep` parameter for `to-list(..)` does not exist anymore.
+  * `to-number(..)` now correctly cast stringified numbers with units `deg`, `rad`, `grad`, `turn`, `s`, `ms`, `dpi`, `dpcm`, `dppx`, `Hz` and `kHz`.
+  * Code quality has been dramatically improved.
 * `1.1.1`: improved things here and there and added SassDoc compliant comments
 * `1.1.0`: dissociated error checking from function logic, and fixed some minor things
 * `1.0.0`: `to-list` improvements, stable API

data/README.md

@@ -1,136 +1,38 @@
-SassyCast
-=========
+# SassyCast
 
 SassyCast is a simple API for type conversion in Sass. Read [API documentation](http://hugogiraudel.com/SassyCast).
 
-# Installation
+## Installation
 
-Clone repository or download [from Github](https://github.com/HugoGiraudel/SassyCast/archive/master.zip).
-
-## Install via ruby gems
 ```
 gem install SassyCast
-````
-
-## Install via bower
-```
-bower install sassy-cast
-```
-
-## `to-bool`
-
-``` scss
-to-bool(false);                 // false
-to-bool(0);                     // false
-to-bool(null);                  // false
-to-bool("");                    // false
-to-bool(true);                  // true
-to-bool(1);                     // true
-to-bool(());                    // true
-to-bool(string);                // true
-to-bool("quoted string");       // true
-to-bool(this is a list);        // true
-to-bool((this: is a map));      // true
-to-bool(1337);                  // true
-to-bool(#000);                  // true
 ```
 
-## `to-number`
-
-``` scss
-to-number(1337);                // 1337
-to-number("0");                 // 0
-to-number("42");                // 42
-to-number("4.2");               // 4.2
-to-number("-10");               // -10
-to-number("-10px");             // -10px
-to-number(true);                // 1
-to-number(false);               // 0
-to-number(string);              // 0
-to-number(this is a list);      // 0
-to-number((this: is a map));    // 0
-to-number(null);                // 0
-to-number(#000);                // 0
 ```
-
-## `to-list`
-
-``` scss
-to-list(0);                     // 0
-to-list(1);                     // 1
-to-list(string);                // string
-to-list(this is a list);        // this is a list
-to-list(this: is a map);        // this, is a map
-to-list(true);                  // true
-to-list(false);                 // false
-to-list(null);                  // null
-to-list(#000);                  // #333
+bower install sassy-cast
 ```
 
-## `to-string`
+## Notes
 
-``` scss
-to-string(0);                   // "0"
-to-string(1);                   // "1"
-to-string(true);                // "true"
-to-string(false);               // "false"
-to-string(null);                // "null"
-to-string(this is a list);      // "this is a list"
-to-string(this, is, a, list);   // "this, is, a, list"
-to-string((this: is a map));    // "(this: is a map)"
-to-string((this: is, a, map));  // "(this: is, a, map)"
-to-string(#000);                // "#333"
-```
-
-## `to-null`
+SassCast has a strict mode in which it will throw errors when failing to cast values (most notably to colors and numbers). You can enable strict-mode with:
 
-``` scss
-to-null(null);                  // null
-to-null(0);                     // null
-to-null(1);                     // null
-to-null(string);                // null
-to-null(this is a list);        // null
-to-null(this: is a map);        // null
-to-null(true);                  // null
-to-null(false);                 // null
-to-null(#333);                  // null
+```scss
+$sc-strict-mode: true;
 ```
 
-## `to-map`
+In non-strict mode, when a value cannot be converted to a number, SassyCast will warn and return `0`. You can change this value with:
 
-``` scss
-to-map(0);                      // (1: 0)
-to-map(1);                      // (1: 1)
-to-map(true);                   // (1: true)
-to-map(false);                  // (1: false)
-to-map(null);                   // (1: null)
-to-map(string);                 // (1: string)
-to-map(this is a list);         // (1: this, 2: is, 3: a, 4: map)
-to-map(this: is a map);         // (this: is a map)
+```scss
+$sc-non-strict-default-number: 0;
 ```
 
-## `to-color`
+In non-strict mode, when a value cannot be converted to a color, SassyCast will warn and return `transparent`. You can change this value with:
 
-``` scss
-to-color(0);                    // null
-to-color(1);                    // null
-to-color(black);                // black
-to-color(#000);                 // black
-to-color("#000");               // black
-to-color(true);                 // null
-to-color(false);                // null
-to-color(null);                 // null
-to-color(string);               // null
-to-color(this is a list);       // null
-to-color((this: is a map));     // null
+```scss
+$sc-non-strict-default-color: transparent;
 ```
 
-## A few things to note:
-
-* When trying to cast something to a number that cannot be converted, it returns `0`
-* When trying to cast something to a color that cannot be converted, it returns `null`
-* Casting to a map use `1` as key (and index in case of a list)
-* Color formats are sometimes converted automatically by Sass; when casting a color to string, the resulting string can be different from the color input
+Note that color formats are sometimes converted automatically by Sass depending on the type of syntaxe used (compressed, expanded, etc.). When casting a color to string, the resulting string can be different from the color input.
 
 ## Credits
 

data/lib/SassyCast.rb

@@ -1,14 +1,20 @@
-require 'compass'
-extension_path = File.expand_path(File.join(File.dirname(__FILE__), ".."))
-Compass::Frameworks.register('SassyCast', :path => extension_path)
+base_directory  = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+stylesheets_path = File.join(base_directory, 'stylesheets')
+
+if (defined? Compass)
+  Compass::Frameworks.register('SassyCast', :stylesheets_directory => stylesheets_path)
+else
+  # compass not found, register on the Sass path via the environment.
+  if ENV.has_key?("SASS_PATH")
+    ENV["SASS_PATH"] = ENV["SASS_PATH"] + File::PATH_SEPARATOR + stylesheets_path
+  else
+    ENV["SASS_PATH"] = stylesheets_path
+  end
+end
 
 #  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 SassyCast
-  VERSION = "1.1.2"
-  DATE = "2016-04-12"
-end
-
-module Sass::Script::Functions
-
+  VERSION = "2.0.0"
+  DATE = "2016-06-03"
 end

data/stylesheets/_options.scss

@@ -0,0 +1,39 @@
+/// Toggle strict mode, in which script will throw when not able to cast a value
+/// into a certain type (mostly color and number). In non-strict mode, it will
+/// return the default value from the given type.
+/// @access public
+/// @type Bool
+$sc-strict-mode: false !default;
+
+/// Default return value for the `to-number(..)` function when running in
+/// non-strict mode.
+/// @access public
+/// @type Number
+$sc-non-strict-default-number: 0 !default;
+
+/// Default return value for the `to-color(..)` function when running in
+/// non-strict mode.
+/// @access public
+/// @type Number
+$sc-non-strict-default-color: transparent !default;
+
+/// Internal map for dynamically accessing default values for non-strict mode.
+/// @access private
+/// @type Map
+$sc-non-strict-defaults: (
+  'number': $sc-non-strict-default-number,
+  'color': $sc-non-strict-default-color,
+);
+
+/// Internal constants map.
+/// @access private
+/// @type Map
+$sc-constants: (
+  'DECIMAL_SPACE': ('0', '1', '2', '3', '4', '5', '6', '7', '8', '9'),
+  'HEXADECIMAL_SPACE': ('0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'),
+  'COLOR_KEYWORDS': (transparent, aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgreen, darkgrey, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, green, greenyellow, grey, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgreen, lightgrey, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, rebeccapurple, red, rosybrown, royalblue, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen),
+  'STRINGIFIED_COLOR_KEYWORDS': ('transparent', 'aliceblue', 'antiquewhite', 'aqua', 'aquamarine', 'azure', 'beige', 'bisque', 'black', 'blanchedalmond', 'blue', 'blueviolet', 'brown', 'burlywood', 'cadetblue', 'chartreuse', 'chocolate', 'coral', 'cornflowerblue', 'cornsilk', 'crimson', 'cyan', 'darkblue', 'darkcyan', 'darkgoldenrod', 'darkgray', 'darkgreen', 'darkgrey', 'darkkhaki', 'darkmagenta', 'darkolivegreen', 'darkorange', 'darkorchid', 'darkred', 'darksalmon', 'darkseagreen', 'darkslateblue', 'darkslategray', 'darkslategrey', 'darkturquoise', 'darkviolet', 'deeppink', 'deepskyblue', 'dimgray', 'dimgrey', 'dodgerblue', 'firebrick', 'floralwhite', 'forestgreen', 'fuchsia', 'gainsboro', 'ghostwhite', 'gold', 'goldenrod', 'gray', 'green', 'greenyellow', 'grey', 'honeydew', 'hotpink', 'indianred', 'indigo', 'ivory', 'khaki', 'lavender', 'lavenderblush', 'lawngreen', 'lemonchiffon', 'lightblue', 'lightcoral', 'lightcyan', 'lightgoldenrodyellow', 'lightgray', 'lightgreen', 'lightgrey', 'lightpink', 'lightsalmon', 'lightseagreen', 'lightskyblue', 'lightslategray', 'lightslategrey', 'lightsteelblue', 'lightyellow', 'lime', 'limegreen', 'linen', 'magenta', 'maroon', 'mediumaquamarine', 'mediumblue', 'mediumorchid', 'mediumpurple', 'mediumseagreen', 'mediumslateblue', 'mediumspringgreen', 'mediumturquoise', 'mediumvioletred', 'midnightblue', 'mintcream', 'mistyrose', 'moccasin', 'navajowhite', 'navy', 'oldlace', 'olive', 'olivedrab', 'orange', 'orangered', 'orchid', 'palegoldenrod', 'palegreen', 'paleturquoise', 'palevioletred', 'papayawhip', 'peachpuff', 'peru', 'pink', 'plum', 'powderblue', 'purple', 'rebeccapurple', 'red', 'rosybrown', 'royalblue', 'saddlebrown', 'salmon', 'sandybrown', 'seagreen', 'seashell', 'sienna', 'silver', 'skyblue', 'slateblue', 'slategray', 'slategrey', 'snow', 'springgreen', 'steelblue', 'tan', 'teal', 'thistle', 'tomato', 'turquoise', 'violet', 'wheat', 'white', 'whitesmoke', 'yellow', 'yellowgreen'),
+  'UNITS': ('px', 'cm', 'mm', '%', 'ch', 'pc', 'in', 'em', 'rem', 'pt', 'ex', 'vw', 'vh', 'vmin', 'vmax', 'ms', 's', 'deg', 'rad', 'grad', 'turn', 'Hz', 'kHz', 'dpi', 'dpcm', 'dppx'),
+  'UNIT_VALUES': (1px, 1cm, 1mm, 1%, 1ch, 1pc, 1in, 1em, 1rem, 1pt, 1ex, 1vw, 1vh, 1vmin, 1vmax, 1ms, 1s, 1deg, 1rad, 1grad, 1turn, 1Hz, 1kHz, 1dpi, 1dpcm, 1dppx),
+  'FALSEY_VALUES': (false, null, '', 0),
+);

data/stylesheets/{private/bool → bool}/_bool.scss

@@ -1,8 +1,8 @@
 /// Convert to bool
 /// @param {*} $value - value to cast
 /// @return {Bool}
-@function _sc-to-bool($value) {
-  @if (not $value or $value == '' or $value == 0) {
+@function to-bool($value) {
+  @if index(map-get($sc-constants, 'FALSEY_VALUES'), $value) {
     @return false;
   }
 

data/stylesheets/color/_color.scss

@@ -0,0 +1,52 @@
+/// Convert to color
+/// @param {*} $value - value to cast
+/// @return {color | null}
+@function to-color($value) {
+  $type: type-of($value);
+
+  // If the value is already a color, we can safely return it.
+  @if ($type == 'color') {
+    @return $value;
+  }
+
+  // If the type is not a string, there is no way we can convert it to a color,
+  // so we warn and return the default color value (or throw in strict mode).
+  @if ($type != 'string') {
+    @return _sc-throw($value, 'color');
+  }
+
+  $value-lower: to-lower-case($value);
+
+  // If the given value is a stringified color keyword, return the accurate
+  // color keyword.
+  $color-keyword-index: index(
+    map-get($sc-constants, 'STRINGIFIED_COLOR_KEYWORDS'),
+    $value-lower
+  );
+
+  @if $color-keyword-index {
+    @return nth(map-get($sc-constants, 'COLOR_KEYWORDS'), $color-keyword-index);
+  }
+
+  // If the color starts with a hash, assume it’s a hexadecimal color triplet
+  // and try to convert it to an actual color.
+  @else if (str-slice($value-lower, 1, 1) == '#') {
+    @return _sc-from-hex($value);
+  }
+
+  // If the color starts with `rgb`, assume it’s a rgb(..) function call and try
+  // to convert it to an actual color.
+  @else if (str-slice($value-lower, 1, 3) == 'rgb') {
+    @return _sc-from-rgb($value);
+  }
+
+  // If the color starts with `hsl`, assume it’s a hsl(..) function call and try
+  // to convert it to an actual color.
+  @else if (str-slice($value-lower, 1, 3) == 'hsl') {
+    @return _sc-from-hsl($value);
+  }
+
+  // If everything has failed, arn and return the default color value (or throw
+  // in strict mode).
+  @return _sc-throw($value, 'color');
+}

data/stylesheets/color/helpers/_from-hex.scss

@@ -0,0 +1,52 @@
+/// Cast a string into a hexadecimal color
+/// @access private
+/// @param {string} $string - string
+/// @return {Color | String} - string or hex color depending on the match
+/// @require {function} _sc-hex-to-dec
+@function _sc-from-hex($string) {
+  $string: to-lower-case($string);
+  $r: ''; 
+  $g: '';
+  $b: '';
+  $hex: map-get($sc-constants, 'HEXADECIMAL_SPACE');
+  $length: str-length($string);
+  $max: if($length == 4, 1, 2);
+
+  // If the length of the value is neither 4, nor 7, it cannot be a valid
+  // hexadecimal triplet, therefore we warn and return the default color value
+  // (or throw in strict mode).
+  @if ($length != 4 and $length != 7) {
+    @return _sc-throw($string, 'color');
+  }
+
+  // Loop through the characters from the value, starting from the second one
+  // to omit the initial hash.
+  @for $i from 2 through $length {
+    $c: str-slice($string, $i, $i);
+
+    // If the character is not part of the hexadecimal space, the color cannot
+    // be a valid hexadecimal triplet, therefore we warn and return the default
+    // color value (or throw in strict mode).
+    @if not index($hex, $c) {
+      @return _sc-throw($string, 'color');
+    }
+
+    @if (str-length($r) < $max) {
+      $r: ($r + $c);
+    } @else if (str-length($g) < $max) {
+      $g: ($g + $c);
+    } @else if (str-length($b) < $max) {
+      $b: ($b + $c);
+    }
+  }
+
+  // If the triplet is a short one, duplicated each found valud to compose a
+  // long version, necessary for the _sc-hex-to-dec(..) calls.
+  @if $length == 4 {
+    $r: $r + $r;
+    $g: $g + $g;
+    $b: $b + $b;
+  }
+
+  @return rgb(_sc-hex-to-dec($r), _sc-hex-to-dec($g), _sc-hex-to-dec($b));
+}

data/stylesheets/color/helpers/_from-hsl.scss

@@ -0,0 +1,46 @@
+/// Cast a string representation of a hsl(..) call into a color
+/// @access private
+/// @param {string} $string - string
+/// @return {Color} - Color
+@function _sc-from-hsl($value) {
+  $value: to-lower-case($value);
+  $channels: ('h': '', 's': '', 'l': '', 'a': '');
+  $channel-keys: map-keys($channels);
+  $current-channel: nth($channel-keys, 1);
+  $discarded-characters: join($channel-keys, (' ', '(', ')'));
+
+  @for $i from 1 through str-length($value) {
+    $character: str-slice($value, $i, $i);
+  
+    // If the character is neither the part of the function name, nor a space or
+    // a parenthese, we proceed further.
+    @if not index($discarded-characters, $character) {
+      // If the current character is a comma, it means we change the current
+      // channel to the next one.
+      @if ($character == ',') {
+        $current-channel-index: index($channel-keys, $current-channel);
+        $current-channel: nth($channel-keys, $current-channel-index + 1);
+      }
+  
+      // If the current character is not a comma, it means it is part of the
+      // value for the current channel and therefore should be saved.
+      @else {
+        $current-channel-value: map-get($channels, $current-channel);
+        $channels: map-merge($channels, ($current-channel: $current-channel-value + $character));
+      }
+    }
+  }
+  
+  $hue: to-number(map-get($channels, 'h'));
+  $saturation: to-number(map-get($channels, 's'));
+  $lightness: to-number(map-get($channels, 'l'));
+  $alpha: map-get($channels, 'a');
+
+  // If there is no alpha channel registered, return a classic hsl(..) call.  
+  @if ($alpha == '') {
+    @return hsl($hue, $saturation, $lightness);
+  }
+  
+  // If there is a registered alpha channel, return a hsla(..) call.  
+  @return hsla($hue, $saturation, $lightness, to-number($alpha));
+}

data/stylesheets/color/helpers/_from-rgb.scss

@@ -0,0 +1,46 @@
+/// Cast a string representation of a rgb(..) call into a color
+/// @access private
+/// @param {String} $string - string
+/// @return {Color} - Color
+@function _sc-from-rgb($value) {
+  $value: to-lower-case($value);
+  $channels: ('r': '', 'g': '', 'b': '', 'a': '');
+  $channel-keys: map-keys($channels);
+  $current-channel: nth($channel-keys, 1);
+  $discarded-characters: join($channel-keys, (' ', '(', ')'));
+
+  @for $i from 1 through str-length($value) {
+    $character: str-slice($value, $i, $i);
+
+    // If the character is neither the part of the function name, nor a space or
+    // a parenthese, we proceed further.
+    @if not index($discarded-characters, $character) {
+      // If the current character is a comma, it means we change the current
+      // channel to the next one.
+      @if ($character == ',') {
+        $current-channel-index: index($channel-keys, $current-channel);
+        $current-channel: nth($channel-keys, $current-channel-index + 1);
+      }
+  
+      // If the current character is not a comma, it means it is part of the
+      // value for the current channel and therefore should be saved.
+      @else {
+        $current-channel-value: map-get($channels, $current-channel);
+        $channels: map-merge($channels, ($current-channel: $current-channel-value + $character));
+      }
+    }
+  }
+  
+  $red: to-number(map-get($channels, 'r'));
+  $green: to-number(map-get($channels, 'g'));
+  $blue: to-number(map-get($channels, 'b'));
+  $alpha: map-get($channels, 'a');
+  
+  // If there is no alpha channel registered, return a classic hsl(..) call.  
+  @if ($alpha == '') {
+    @return rgb($red, $green, $blue);
+  }
+
+  // If there is a registered alpha channel, return a rgba(..) call.    
+  @return rgba($red, $green, $blue, to-number($alpha));
+}

data/stylesheets/{private/color → color}/helpers/_hex-to-dec.scss

@@ -5,18 +5,15 @@
 @function _sc-hex-to-dec($string) {
   $string: to-lower-case($string);
   $length: str-length($string);
-  $hex: (
-    '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
-    'a', 'b', 'c', 'd', 'e', 'f'
-  );
+  $hex: map-get($sc-constants, 'HEXADECIMAL_SPACE');
 
-  $dec: 0;
+  $decimal: 0;
 
   @for $i from 1 through $length {
-    $factor: 1 + (15 * ($length - $i));
+    $factor: 1 + (length($hex) * ($length - $i));
     $index: index($hex, str-slice($string, $i, $i));
-    $dec: $dec + $factor * ($index - 1);
+    $decimal: $decimal + $factor * ($index - 1);
   }
 
-  @return $dec;
+  @return $decimal;
 }

data/stylesheets/helpers/throw.scss

@@ -0,0 +1,15 @@
+/// Helper function to throw when running in strict mode, or warn and return
+/// default value for expected type when running in non-strict mode.
+/// @param {*} $value
+/// @param {String} $expected-type
+@function _sc-throw($value, $expected-type) {
+  $return-value: map-get($sc-non-strict-defaults, $expected-type);
+
+  @if $sc-strict-mode {
+    @error 'Could not cast `#{inspect($value)}` to #{$expected-type}.';
+  } @else {
+    @warn 'Could not cast `#{inspect($value)}` to #{$expected-type}; returning `#{$return-value}`.';
+  }
+
+  @return $return-value;
+}

data/stylesheets/list/_list.scss

@@ -0,0 +1,19 @@
+/// Convert to list
+/// @param {*} $value - value to cast
+/// @return {List}
+@function to-list($value) {
+  $type: type-of($value);
+  
+  // If the value is already a list, we can safely return it.
+  @if ($type == 'list') {
+    @return $value;
+  }
+
+  // If the value is a map, we return a zip of keys and values (aka a list-map).
+  @if ($type == 'map') {
+    @return zip(map-keys($value), map-values($value));
+  }
+
+  // Else we wrap the item in a single-item list.
+  @return ($value,);
+}

data/stylesheets/map/_map.scss

@@ -0,0 +1,31 @@
+/// Convert to map
+/// @param {*} $value - value to cast
+/// @return {Map}
+@function to-map($value) {
+  $type: type-of($value);
+
+  // If the value is already a map, we can safely return it.
+  @if ($type == 'map') {
+    @return $value;
+  }
+
+  // If the type is a list, we return an empty list if it has a no item or we
+  // map each item to its index in the list.
+  @if ($type == 'list') {
+    $length: length($value);
+
+    @if ($length == 0) {
+      @return ();
+    }
+
+    $map: ();
+
+    @for $i from 1 through $length {
+      $map: map-merge($map, ($i: nth($value, $i)));
+    }
+
+    @return $map;
+  }
+
+  @return (1: $value);
+}

data/stylesheets/{private/null → null}/_null.scss

@@ -1,6 +1,6 @@
 /// Convert to null
 /// @param {*} $value - value to cast
 /// @return {Null}
-@function _sc-to-null($value) {
+@function to-null($value) {
   @return null;
 }

data/stylesheets/number/_number.scss

@@ -0,0 +1,75 @@
+/// Cast a value to a number if possible or return 0
+/// @param {String} $value - complete source
+/// @return {Number}
+@function to-number($value) {
+  $type: type-of($value);
+
+  // If the value is already a number, we can safely return it.
+  @if ($type == 'number') {
+    @return $value;
+  }
+
+  // If the value is the `true` boolean, we return 1.
+  @if ($value == true)  {
+    @return 1;
+  }
+
+  // If the value is the `false` boolean, we return 0.
+  @if ($value == false) {
+    @return 0;
+  }
+
+  // If the type is not a string, there is no way we can convert it to a number,
+  // so we warn and return the default number value (or throw in strict mode).
+  @if ($type != 'string') {
+    @return _sc-throw($value, 'number');
+  }
+
+  // At this point we have discarded all the edge cases so we can start trying
+  // to cast the value into a number.
+  $pointer: 1;
+  $result: 0;
+  $first-character: str-slice($value, $pointer, $pointer);
+  $allowed-first-character: join(('-', '.'), map-get($sc-constants, 'DECIMAL_SPACE'));
+
+  // We perform an early check for errors. If value starts with neither a number
+  // nor a minus sign, it cannot be casted to a number. Therefore we warn and
+  // return the default number value (or throw in strict mode).
+  @if not index($allowed-first-character, $first-character) {
+    @return _sc-throw($value, 'number');
+  }
+
+  // In case the value starts with a dot, we assume it is a float and pad it
+  // with a zero.
+  @if ($first-character == '.') {
+    $value: '0' + $value;
+  }
+
+  // We find the integer part of the value.
+  $find-integer: _sc-find-integer($value, $pointer);
+  $pointer: nth($find-integer, 1);
+  $result:  nth($find-integer, 2);
+
+  // If there still is a dot, it means we have to check for the digits part of
+  // the value.
+  @if (str-slice($value, $pointer, $pointer) == '.') {
+    $find-digits: _sc-find-digits($value, $pointer);
+    $pointer: nth($find-digits, 1);
+    $digits:  nth($find-digits, 2);
+    $result: ($result + $digits);
+  }
+
+  // If the first character is a minus symbol, it means the number is negative
+  // so we can multiply it per -1.
+  @if ($first-character == '-') {
+    $result: ($result * -1);
+  }
+
+  // If we are still not done with the evaluation, it means there could be a CSS
+  // unit, so we check for it.
+  @if ($pointer <= str-length($value)) {
+    $result: _sc-unit($result, str-slice($value, $pointer));
+  }
+
+  @return $result;
+}

data/stylesheets/{private/number → number}/helpers/_find-digits.scss

@@ -6,7 +6,7 @@
 @function _sc-find-digits($source, $pointer) {
   $source: to-lower-case($source);
   $length: str-length($source);
-  $numbers: ('0', '1', '2', '3', '4', '5', '6', '7', '8', '9');
+  $numbers: map-get($sc-constants, 'DECIMAL_SPACE');
   $result: 0;
   $runs: 1;
 

data/stylesheets/{private/number → number}/helpers/_find-integer.scss

@@ -6,7 +6,7 @@
 @function _sc-find-integer($source, $pointer) {
   $source: to-lower-case($source);
   $length: str-length($source);
-  $numbers: ('0', '1', '2', '3', '4', '5', '6', '7', '8', '9');
+  $numbers: map-get($sc-constants, 'DECIMAL_SPACE');
   $result: 0;
 
   @while ($pointer <= $length) {

data/stylesheets/number/helpers/_unit.scss

@@ -0,0 +1,15 @@
+/// Tries to find a unit that would match a CSS length
+/// @access private
+/// @param {Number} $number - number
+/// @param {String}   $unit - potential unit
+/// @return {Number} length (0 if cast failed)
+@function _sc-unit($number, $unit) {
+  $units: map-get($sc-constants, 'UNIT_VALUES');
+  $index: index(map-get($sc-constants, 'UNITS'), $unit);
+
+  @if not $index {
+    @return _sc-throw($number, 'number');
+  }
+
+  @return ($number * nth($units, $index));
+}

data/stylesheets/{private/string → string}/_string.scss

@@ -1,9 +1,10 @@
 /// Convert to string
 /// @param {*} $value - value to cast
 /// @return {String}
-@function _sc-to-string($value) {
+@function to-string($value) {
   $type: type-of($value);
 
+  // If the value is already a string, we can safely return it.
   @if ($type == 'string') {
     @return $value;
   }
@@ -12,6 +13,5 @@
     @warn 'Beware! Sass does some color conversion. The resulting string may be different from the color input.';
   }
 
-
   @return inspect($value);
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: SassyCast
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Hugo Giraudel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-12 00:00:00.000000000 Z
+date: 2016-06-03 00:00:00.000000000 Z
 dependencies: []
 description: Sass API for type conversion.
 email:
@@ -20,32 +20,23 @@ files:
 - CHANGELOG.md
 - README.md
 - lib/SassyCast.rb
-- stylesheets/SassyCast.scss
-- stylesheets/private/_all.scss
-- stylesheets/private/bool/_bool.scss
-- stylesheets/private/color/_color.scss
-- stylesheets/private/color/helpers/_from-hex.scss
-- stylesheets/private/color/helpers/_from-hsl.scss
-- stylesheets/private/color/helpers/_from-rgb.scss
-- stylesheets/private/color/helpers/_get-color-value.scss
-- stylesheets/private/color/helpers/_hex-to-dec.scss
-- stylesheets/private/list/_list.scss
-- stylesheets/private/map/_map.scss
-- stylesheets/private/null/_null.scss
-- stylesheets/private/number/_number.scss
-- stylesheets/private/number/helpers/_find-digits.scss
-- stylesheets/private/number/helpers/_find-integer.scss
-- stylesheets/private/number/helpers/_length.scss
-- stylesheets/private/number/helpers/_pow.scss
-- stylesheets/private/string/_string.scss
-- stylesheets/public/_all.scss
-- stylesheets/public/bool/_bool.scss
-- stylesheets/public/color/_color.scss
-- stylesheets/public/list/_list.scss
-- stylesheets/public/map/_map.scss
-- stylesheets/public/null/_null.scss
-- stylesheets/public/number/_number.scss
-- stylesheets/public/string/_string.scss
+- stylesheets/_options.scss
+- stylesheets/bool/_bool.scss
+- stylesheets/color/_color.scss
+- stylesheets/color/helpers/_from-hex.scss
+- stylesheets/color/helpers/_from-hsl.scss
+- stylesheets/color/helpers/_from-rgb.scss
+- stylesheets/color/helpers/_hex-to-dec.scss
+- stylesheets/helpers/throw.scss
+- stylesheets/list/_list.scss
+- stylesheets/map/_map.scss
+- stylesheets/null/_null.scss
+- stylesheets/number/_number.scss
+- stylesheets/number/helpers/_find-digits.scss
+- stylesheets/number/helpers/_find-integer.scss
+- stylesheets/number/helpers/_pow.scss
+- stylesheets/number/helpers/_unit.scss
+- stylesheets/string/_string.scss
 homepage: https://github.com/HugoGiraudel/SassyCast/
 licenses: []
 metadata: {}
@@ -65,7 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: SassyCast
-rubygems_version: 2.5.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: SassyCast is a Sass-powered API for type conversion.

data/stylesheets/SassyCast.scss

@@ -1,2 +0,0 @@
-@import "private/all";
-@import "public/all";

data/stylesheets/private/_all.scss

@@ -1,16 +0,0 @@
-@import "bool/bool";
-@import "number/helpers/find-integer";
-@import "number/helpers/find-digits";
-@import "number/helpers/pow";
-@import "number/helpers/length";
-@import "number/number";
-@import "string/string";
-@import "list/list";
-@import "map/map";
-@import "null/null";
-@import "color/helpers/from-rgb";
-@import "color/helpers/from-hsl";
-@import "color/helpers/from-hex";
-@import "color/helpers/get-color-value";
-@import "color/helpers/hex-to-dec";
-@import "color/color";

data/stylesheets/private/color/_color.scss

@@ -1,55 +0,0 @@
-/// Convert to color
-/// @param {*} $value - value to cast
-/// @return {color | null}
-@function _sc-to-color($value) {
-  $type: type-of($value);
-
-  @if ($type == 'color') {
-    @return $value;
-  }
-
-  @if ($type != 'string') {
-    //@warn 'Could not cast `#{inspect($value)}` to color.';
-    @return null;
-  }
-
-  $value-lower: to-lower-case($value);
-  $colors: transparent black silver gray white maroon red purple fuchsia green lime olive yellow navy blue teal aqua aliceblue antiquewhite aqua aquamarine azure beige bisque black blanchedalmond blue blueviolet brown burlywood cadetblue chartreuse chocolate coral cornflowerblue cornsilk crimson cyan darkblue darkcyan darkgoldenrod darkgray darkgreen darkgrey darkkhaki darkmagenta darkolivegreen darkorange darkorchid darkred darksalmon darkseagreen darkslateblue darkslategray darkslategrey darkturquoise darkviolet deeppink deepskyblue dimgray dimgrey dodgerblue firebrick floralwhite forestgreen fuchsia gainsboro ghostwhite gold goldenrod gray green greenyellow grey honeydew hotpink indianred indigo ivory khaki lavender lavenderblush lawngreen lemonchiffon lightblue lightcoral lightcyan lightgoldenrodyellow lightgray lightgreen lightgrey lightpink lightsalmon lightseagreen lightskyblue lightslategray lightslategrey lightsteelblue lightyellow lime limegreen linen magenta maroon mediumaquamarine mediumblue mediumorchid mediumpurple mediumseagreen mediumslateblue mediumspringgreen mediumturquoise mediumvioletred midnightblue mintcream mistyrose moccasin navajowhite navy oldlace olive olivedrab orange orangered orchid palegoldenrod palegreen paleturquoise palevioletred papayawhip peachpuff peru pink plum powderblue purple red rosybrown royalblue saddlebrown salmon sandybrown seagreen seashell sienna silver skyblue slateblue slategray slategrey snow springgreen steelblue tan teal thistle tomato turquoise violet wheat white whitesmoke yellow yellowgreen;
-  $keywords: ();
-
-  // Filling $keywords with stringified color keywords
-  @each $color in $colors {
-    $keywords: append($keywords, $color + '');
-  }
-
-  // Deal with inherit keyword
-  @if ($value-lower == 'inherit') {
-    @return unquote($value);
-  }
-
-  // Deal with color keywords
-  @if index($keywords, $value-lower) {
-    @return nth($colors, index($keywords, $value-lower));
-  }
-
-  // Deal with hexadecimal triplets
-  @else if (str-slice($value-lower, 1, 1) == '#') {
-    @return _sc-from-hex($value);
-  }
-
-  // Deal with rgb(a) colors
-  @else if (str-slice($value-lower, 1, 3) == 'rgb') {
-    @return _sc-from-rgb($value);
-  }
-
-  // Deal with hsl(a) colors
-  @else if (str-slice($value-lower, 1, 3) == 'hsl') {
-    @return _sc-from-hsl($value);
-  }
-
-  // Return value
-  @else {
-    //@warn 'Could not cast `#{inspect($value)}` to color.';
-    @return null;
-  }
-}

data/stylesheets/private/color/helpers/_from-hex.scss

@@ -1,39 +0,0 @@
-/// Cast a string into a hexadecimal color
-/// @access private
-/// @param {string} $string - string
-/// @return {Color | String} - string or hex color depending on the match
-/// @require {function} _hex-to-dec
-@function _sc-from-hex($string) {
-  $string-lower: to-lower-case($string);
-  $r: '';  $g: ''; $b: '';
-  $hex: '0' '1' '2' '3' '4' '5' '6' '7' '8' '9' 'a' 'b' 'c' 'd' 'e' 'f';
-  $length: str-length($string);
-  $max: if($length == 4, 1, 2);
-
-  // Check for length accuracy
-  @if ($length != 4 and $length != 7) {
-    @return $string;
-  }
-
-  // Loop from the second character (omitting #)
-  @for $i from 2 through $length {
-    $c: str-slice($string-lower, $i, $i);
-
-    // If wrong character, return
-    @if not index($hex, $c) {
-      @return $string;
-    }
-
-    @if      str-length($r) < $max { $r: $r + $c }
-    @else if str-length($g) < $max { $g: $g + $c }
-    @else if str-length($b) < $max { $b: $b + $c }
-  }
-
-  @if $length == 4 {
-    $r: $r + $r;
-    $g: $g + $g;
-    $b: $b + $b;
-  }
-
-  @return rgb(_sc-hex-to-dec($r), _sc-hex-to-dec($g), _sc-hex-to-dec($b));
-}

data/stylesheets/private/color/helpers/_from-hsl.scss

@@ -1,53 +0,0 @@
-/// Cast a string into a hsl color
-/// @access private
-/// @param {string} $string - string
-/// @return {Color | String} - string or hsl color depending on the match
-/// @require {function} _get-color-value
-@function _sc-from-hsl($string) {
-  $frags: ();
-  $string-lower: to-lower-case($string);
-  $is-alpha: str-slice($string-lower, 4, 4) == 'a';
-  $length: str-length($string);
-  $start: str-index($string, "(");
-
-  @for $i from $start through $length {
-    $token: str-slice($string-lower, $i, $i);
-    @if ($token == ' ') {
-      // @continue;
-    } @else if ($token == '(' or $token == ',') {
-      $frags: append($frags, "");
-    } @else if ($token == ')') {
-      @if (length($frags) != if($is-alpha, 4, 3)) {
-        @return $string; // Parsing error
-      }
-
-      $hue: _sc-get-color-value(nth($frags, 1));
-      $saturation: _sc-get-color-value(nth($frags, 2));
-      $lightness: _sc-get-color-value(nth($frags, 3));
-
-      @if (not $hue or not $saturation or not $lightness) {
-        @return $string;
-      }
-
-      @if $is-alpha {
-        @if (length($frags) != 4) {
-          @return $string; // No alpha channel found
-        }
-
-        $alpha: _sc-get-color-value(nth($frags, 4));
-
-        @if not $alpha {
-          @return $string; // Error parsing alpha channel
-        }
-
-        @return hsla($hue, $saturation, $lightness, $alpha);
-      }
-
-      @return hsl($hue, $saturation, $lightness);
-    } @else {
-      $frags: set-nth($frags, length($frags), nth($frags, length($frags)) + $token);
-    }
-  }
-
-  @return $string;
-}

data/stylesheets/private/color/helpers/_from-rgb.scss

@@ -1,54 +0,0 @@
-/// Cast a string into a rgb color
-/// @access private
-/// @param {String} $string - string
-/// @return {Color | String} - string or rgb color depending on the match
-/// @require {function} _get-color-value
-@function _sc-from-rgb($string) {
-  $string-lower: to-lower-case($string);
-  $frags: ();
-  $is-alpha: str-slice($string-lower, 4, 4) == 'a';
-  $start: str-index($string, '(');
-  $length: str-length($string);
-
-  @for $i from $start through $length {
-    $token: str-slice($string-lower, $i, $i);
-
-    @if ($token == ' ') {
-      // @continue;
-    } @else if ($token == '(' or $token == ',') {
-      $frags: append($frags, '');
-    } @else if ($token == ')') {
-      @if length($frags) != if($is-alpha, 4, 3) {
-        @return $string; // Parsing error
-      }
-
-      $red: _sc-get-color-value(nth($frags, 1));
-      $green: _sc-get-color-value(nth($frags, 2));
-      $blue: _sc-get-color-value(nth($frags, 3));
-
-      @if (not $red or not $green or not $blue) {
-        @return $string;
-      }
-
-      @if $is-alpha {
-        @if length($frags) != 4 {
-          @return $string; // No alpha channel found
-        }
-
-        $alpha: _sc-get-color-value(nth($frags, 4));
-
-        @if not $alpha {
-          @return $string; // Error parsing alpha channel
-        }
-
-        @return rgba($red, $green, $blue, $alpha);
-      }
-
-      @return rgb($red, $green, $blue);
-    } @else {
-      $frags: set-nth($frags, length($frags), nth($frags, length($frags)) + $token);
-    }
-  }
-
-  @return $string;
-}

data/stylesheets/private/color/helpers/_get-color-value.scss

@@ -1,21 +0,0 @@
-/// Cast a stringified number / stringified percentage into number type
-/// @access private
-/// @param {string} $string - string
-/// @return {Number} - unitless number or percentage
-/// @require {function} to-number
-@function _sc-get-color-value($string) {
-  $first: str-slice($string, 1, 1);
-
-  // Pad <1 values with a leading 0
-  @if ($first == '.') {
-    $string: '0' + $string;
-  }
-
-  $last: str-slice($string, -1, -1);
-
-  @if ($last == '%') {
-    @return _sc-to-number(str-slice($string, 1, -2), 2) * 1%;
-  }
-
-  @return _sc-to-number($string);
-}

data/stylesheets/private/list/_list.scss

@@ -1,26 +0,0 @@
-/// Convert to list
-/// @param {*} $value - value to cast
-/// @param {String} $keep ('both') - whether to keep `keys`, `values` or `both` when casting a map
-/// @return {List}
-@function _sc-to-list($value, $keep: 'both') {
-  $type: type-of($value);
-
-  @if ($type == 'list') {
-    @return $value;
-  }
-
-  @if ($type == 'map') {
-    $keys: map-keys($value);
-    $values: map-values($value);
-
-    @if ($keep == 'values') {
-      @return $values;
-    } @else if ($keep == 'keys') {
-      @return $keys;
-    } @else {
-      @return zip($keys, $values);
-    }
-  }
-
-  @return ($value,);
-}

data/stylesheets/private/map/_map.scss

@@ -1,28 +0,0 @@
-/// Convert to map
-/// @param {*} $value - value to cast
-/// @return {Map}
-@function _sc-to-map($value) {
-  $type: type-of($value);
-
-  @if ($type == 'map') {
-    @return $value;
-  }
-
-  @if ($type == 'list') {
-    $length: length($value);
-
-    @if ($length == 0) {
-      @return ();
-    } @else {
-      $map: ();
-
-      @for $i from 1 through $length {
-        $map: map-merge($map, ($i: nth($value, $i)));
-      }
-
-      @return $map;
-    }
-  }
-
-  @return (1: $value);
-}

data/stylesheets/private/number/_number.scss

@@ -1,59 +0,0 @@
-/// Cast a value to a number if possible or return 0
-/// @param {String} $value - complete source
-/// @return {Number}
-@function _sc-to-number($value) {
-  $type: type-of($value);
-
-  // In case everything's good
-  @if ($type == 'number') {
-    @return $value;
-  }
-
-  // Boolean to number
-  @if ($value == true)  {
-    @return 1;
-  }
-
-  // Fail
-  @if ($type != 'string') {
-    @return 0;
-  }
-
-  // Trying to cast
-  $pointer: 1;
-  $result: 0;
-  $allowed: ('-', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9'); // Allowed characted to start with
-  $first: str-slice($value, $pointer, $pointer); // First character of the number
-  $minus: $first == '-'; // Is it negative?
-
-  // Early check for errors
-  @if not index($allowed, $first) {
-    @warn 'Could not cast `#{inspect($value)}` into number.';
-    @return 0;
-  }
-
-  // Find the integer part
-  $find-integer: _sc-find-integer($value, $pointer);
-  $pointer: nth($find-integer, 1);
-  $result:  nth($find-integer, 2);
-
-  // Find digits
-  @if (str-slice($value, $pointer, $pointer) == '.') {
-    $find-digits: _sc-find-digits($value, $pointer);
-    $pointer: nth($find-digits, 1);
-    $digits:  nth($find-digits, 2);
-    $result: ($result + $digits);
-  }
-
-  // In case of negative
-  @if $minus {
-    $result: ($result * -1);
-  }
-
-  // In case of possible CSS unit
-  @if ($pointer < str-length($value)) {
-    $result: _sc-length($result, str-slice($value, $pointer));
-  }
-
-  @return $result;
-}

data/stylesheets/private/number/helpers/_length.scss

@@ -1,17 +0,0 @@
-/// Tries to find a unit that would match a CSS length
-/// @access private
-/// @param {Number} $number - number
-/// @param {String}   $unit - potential unit
-/// @return {Number} length (0 if cast failed)
-@function _sc-length($number, $unit) {
-  $strings: 'px' 'cm' 'mm' '%' 'ch' 'pc' 'in' 'em' 'rem' 'pt' 'pc' 'ex' 'vw' 'vh' 'vmin' 'vmax';
-  $units:   1px  1cm  1mm  1%  1ch  1pc  1in  1em  1rem  1pt  1pc  1ex  1vw  1vh  1vmin  1vmax;
-  $index: index($strings, $unit);
-
-  @if not $index {
-    @warn 'Unknown unit `#{inspect($unit)}`.';
-    @return 0;
-  }
-
-  @return ($number * nth($units, $index));
-}

data/stylesheets/public/_all.scss

@@ -1,7 +0,0 @@
-@import "bool/bool";
-@import "number/number";
-@import "string/string";
-@import "list/list";
-@import "map/map";
-@import "null/null";
-@import "color/color";

data/stylesheets/public/bool/_bool.scss

@@ -1,3 +0,0 @@
-@function to-bool($value) {
-  @return _sc-to-bool($value);
-}

data/stylesheets/public/color/_color.scss

@@ -1,3 +0,0 @@
-@function to-color($value) {
-  @return _sc-to-color($value);
-}

data/stylesheets/public/list/_list.scss

@@ -1,3 +0,0 @@
-@function to-list($value, $keep: 'both') {
-  @return _sc-to-list($value, $keep);
-}

data/stylesheets/public/map/_map.scss

@@ -1,3 +0,0 @@
-@function to-map($value) {
-  @return _sc-to-map($value);
-}

data/stylesheets/public/null/_null.scss

@@ -1,3 +0,0 @@
-@function to-null($value) {
-  @return _sc-to-null($value);
-}

data/stylesheets/public/number/_number.scss

@@ -1,3 +0,0 @@
-@function to-number($value) {
-  @return _sc-to-number($value);
-}

data/stylesheets/public/string/_string.scss

@@ -1,3 +0,0 @@
-@function to-string($value) {
-  @return _sc-to-string($value);
-}