SassyCast 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4770cd04049b0257d92291e040aaebe64e28ecad
+  data.tar.gz: 166fce1bcd86158f1b2304e4057ac43705fbd027
+SHA512:
+  metadata.gz: 8b118cf974c1a739297ad915521d36fc182d3f139eb1a24ff32d75cd01b244f879125a7d37d270838560a44dc628556f913ded32d08b90b23e68938ba2e65eba
+  data.tar.gz: 7de8734df558b6079ef63f840bd9fd0c67ada77a24ace850ea47937ed1b262f670f7733c05355d308998a632ca1daf749b413154e218fa9444d3bdf345a998ad

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+
+* `0.0.1`: initial commit

data/README.md

@@ -0,0 +1,119 @@
+SassyCast
+=========
+
+SassyCast is a simple API for type conversion in Sass.
+
+## `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
+```
+
+## `to-string`
+
+``` 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`
+
+``` 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
+```
+
+## `to-map`
+
+``` 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)
+```
+
+## `to-color`
+
+``` 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
+```
+
+## 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 converted automatically by Sass; when casting a color to string, the resulting string can be different from the color input

data/lib/SassyCast.rb

@@ -0,0 +1,14 @@
+require 'compass'
+extension_path = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+Compass::Frameworks.register('SassyCast', :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 SassyCast
+  VERSION = "0.0.1"
+  DATE = "2014-01-27"
+end
+
+module Sass::Script::Functions
+
+end

data/stylesheets/SassyCast.scss

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

data/stylesheets/types/bool/_bool.scss

@@ -0,0 +1,12 @@
+// Convert to bool
+// --------------------------------------------------------------------------------
+// @param $value: value to cast
+// --------------------------------------------------------------------------------
+// @return [bool]
+
+@function to-bool($value) {
+  @if not $value or $value == "" or $value == 0 {
+    @return false;
+  }
+  @return true;
+}

data/stylesheets/types/color/_color.scss

@@ -0,0 +1,62 @@
+@import "helpers/from-rgb";
+@import "helpers/from-hsl";
+@import "helpers/from-hex";
+@import "helpers/get-color-value";
+@import "helpers/hex-to-dec";
+
+// Convert to color
+// --------------------------------------------------------------------------------
+// @param $value: value to cast
+// --------------------------------------------------------------------------------
+// @return [color] | null
+
+@function to-color($value) {
+  @if type-of($value) == color {
+    @return $value;
+  }
+
+  @if type-of($value) != 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 _from-hex($value);
+  }
+  
+  // Deal with rgb(a) colors
+  @else if str-slice($value-lower, 1, 3) == 'rgb' {
+    @return _from-rgb($value);
+  }
+  
+  // Deal with hsl(a) colors
+  @else if str-slice($value-lower, 1, 3) == 'hsl' {
+    @return _from-hsl($value);
+  }
+  
+  // Return value
+  @else {
+    //@warn "Could not cast `#{inspect($value)}` to color.";
+    @return null;
+  }
+}

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

@@ -0,0 +1,34 @@
+@function _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(_hex-to-dec($r), _hex-to-dec($g), _hex-to-dec($b));
+}

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

@@ -0,0 +1,41 @@
+@function _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: _get-color-value(nth($frags, 1));
+      $saturation: _get-color-value(nth($frags, 2));
+      $lightness: _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: _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/types/color/helpers/_from-rgb.scss

@@ -0,0 +1,41 @@
+@function _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: _get-color-value(nth($frags, 1));
+      $green: _get-color-value(nth($frags, 2));
+      $blue: _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: _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/types/color/helpers/_get-color-value.scss

@@ -0,0 +1,12 @@
+@function _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);
+  
+  @return if($last == '%', to-number(str-slice($string, 1, -2), 2) * 1%, to-number($string));
+}

data/stylesheets/types/color/helpers/_hex-to-dec.scss

@@ -0,0 +1,14 @@
+@function _hex-to-dec($string){
+  $hex: "0" "1" "2" "3" "4" "5" "6" "7" "8" "9" "a" "b" "c" "d" "e" "f";
+  $string: to-lower-case($string);
+  $length: str-length($string);
+  
+  $dec: 0;
+  @for $i from 1 through $length {
+    $factor: 1 + ( 15 * ( $length - $i ));
+    $index: index($hex, str-slice($string, $i, $i));
+    $dec: $dec + $factor * ($index - 1);
+  }
+  
+  @return $dec;
+} 

data/stylesheets/types/list/_list.scss

@@ -0,0 +1,19 @@
+// Convert to list
+// --------------------------------------------------------------------------------
+// @param $value: value to cast
+// --------------------------------------------------------------------------------
+// @return [list]
+
+@function to-list($value) {
+  @if type-of($value) == map {
+    $keys: ();
+    $values: ();
+    @each $key, $val in $value {
+      $keys: append($keys, $key);
+      $values: append($values, $val);
+    }
+    @return zip($keys, $values);
+  }
+
+  @return if(type-of($value) != list, ($value,), $value);
+}

data/stylesheets/types/map/_map.scss

@@ -0,0 +1,17 @@
+// Convert to map
+// --------------------------------------------------------------------------------
+// @param $value: value to cast
+// --------------------------------------------------------------------------------
+// @return [map]
+
+@function to-map($value) {
+  @if type-of($value) == list {
+    $map: ();
+    @for $i from 1 through length($value) {
+      $map: map-merge($map, ($i: nth($value, $i)));
+    }
+    @return $map;
+  }
+
+  @return if(type-of($value) != map, (1: $value), $value);
+}

data/stylesheets/types/null/_null.scss

@@ -0,0 +1,9 @@
+// Convert to null
+// --------------------------------------------------------------------------------
+// @param $value: value to cast
+// --------------------------------------------------------------------------------
+// @return null
+
+@function to-null($value) {
+  @return null;
+}

data/stylesheets/types/number/_number.scss

@@ -0,0 +1,65 @@
+@import "helpers/find-integer";
+@import "helpers/find-digits";
+@import "helpers/pow";
+@import "helpers/length";
+
+// Parses a JSON encoded number
+// --------------------------------------------------------------------------------
+// @param [string] $source: JSON complete source
+// @param [number] $pointer: current pointer
+// --------------------------------------------------------------------------------
+// @throw "Unexpected token $token."
+// @throw "Unexpected end of stream."
+// --------------------------------------------------------------------------------
+// @return [list|false] (new pointer, parsed number)
+
+@function to-number($source) {
+  @if type-of($source) == number {
+    @return $source;
+  }
+
+  @if $source == true  {
+    @return 1;
+  }
+
+  @if type-of($source) != string {
+    @return 0;
+  }
+
+  $pointer: 1;
+  $result: 0;
+  $allowed: '-' '0' '1' '2' '3' '4' '5' '6' '7' '8' '9'; // Allowed characted to start with
+  $first: str-slice($source, $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($source)} into number.";
+    @return 0;
+  }
+
+  // Find the integer part
+  $find-integer: _find-integer($source, $pointer);
+  $pointer: nth($find-integer, 1);
+  $result:  nth($find-integer, 2);
+
+  // Find digits
+  @if str-slice($source, $pointer, $pointer) == '.' {
+    $find-digits: _find-digits($source, $pointer);
+    $pointer: nth($find-digits, 1);
+    $digits:  nth($find-digits, 2);
+    $result: $result + $digits;
+  }
+
+  @if $minus {
+    $result: $result * -1;
+  }
+
+
+//  @return $result $pointer str-length($source);
+  @if $pointer < str-length($source) {
+    $result: _length($result, str-slice($source, $pointer));
+  }
+
+  @return $result;
+}

data/stylesheets/types/number/helpers/_find-digits.scss

@@ -0,0 +1,36 @@
+// Parses a JSON encoded number to find the digits
+// --------------------------------------------------------------------------------
+// @param [string] $source: JSON complete source
+// @param [number] $pointer: current pointer
+// --------------------------------------------------------------------------------
+// @throw "Unexpected token $token."
+// --------------------------------------------------------------------------------
+// @return [list|false] (new pointer, parsed number)
+
+@function _find-digits($source, $pointer) {
+  $source: to-lower-case($source);
+  $length: str-length($source);
+  $numbers: '0' '1' '2' '3' '4' '5' '6' '7' '8' '9';
+  $result: 0;
+  $runs: 1;
+
+  @while $pointer <= $length {
+    $token: str-slice($source, $pointer, $pointer);
+    $index: index($numbers, $token);
+
+    @if $token == '.' {
+      // @continue;
+    }
+    @else if $index and $index > 0 {
+      $runs: $runs * 10;
+      $result: $result * 10 + ($index - 1);
+    }
+    @else {
+      @return $pointer, $result / $runs;
+    }
+
+    $pointer: $pointer + 1;
+  }
+
+  @return $pointer, $result / $runs;
+}

data/stylesheets/types/number/helpers/_find-integer.scss

@@ -0,0 +1,35 @@
+// Parses a JSON encoded number to find the integer part
+// --------------------------------------------------------------------------------
+// @param [string] $source: JSON complete source
+// @param [number] $pointer: current pointer
+// --------------------------------------------------------------------------------
+// @throw "Unexpected token $token."
+// --------------------------------------------------------------------------------
+// @return [list|false] (new pointer, parsed number)
+
+@function _find-integer($source, $pointer) {
+  $source: to-lower-case($source);
+  $length: str-length($source);
+  $numbers: '0' '1' '2' '3' '4' '5' '6' '7' '8' '9';
+  $result: 0;
+
+  @while $pointer <= $length {
+    $token: str-slice($source, $pointer, $pointer);
+    $index: index($numbers, $token);
+
+    @if $token == '-' {
+      // do nothing
+    }
+    @else if $index {
+      $result: $result * 10 + ($index - 1);
+    }
+    @else {
+      @return $pointer, $result;
+    }
+
+    $pointer: $pointer + 1;
+  }
+
+  @return $pointer, $result;
+}
+

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

@@ -0,0 +1,12 @@
+@function _length($number, $unit) {
+  $strings: 'px' 'cm' 'mm' '%' 'ch' 'pica' 'in' 'em' 'rem' 'pt' 'pc' 'ex' 'vw' 'vh' 'vmin' 'vmax';
+  $units:   1px  1cm  1mm  1%  1ch  1pica  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/types/number/helpers/_pow.scss

@@ -0,0 +1,22 @@
+// Power function
+// --------------------------------------------------------------------------------
+// @param [number] $x: number
+// @param [number] $n: power
+// --------------------------------------------------------------------------------
+// @return [number] $x ^ $n
+
+@function _pow($x, $n) {
+  $ret: 1;
+
+  @if $n >= 0 {
+    @for $i from 1 through $n {
+      $ret: $ret * $x;
+    }
+  } @else {
+    @for $i from $n to 0 {
+      $ret: $ret / $x;
+    }
+  }
+
+  @return $ret;
+}

data/stylesheets/types/string/_string.scss

@@ -0,0 +1,12 @@
+// Convert to string
+// --------------------------------------------------------------------------------
+// @param $value: value to cast
+// --------------------------------------------------------------------------------
+// @return [string]
+
+@function to-string($value) {
+  @if type-of($value) == color {
+    @warn "Beware! Sass does some color conversion. The resulting string may be different from the color input.";
+  }
+  @return if(type-of($value) != string, inspect($value), $value);
+}

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: SassyCast
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hugo Giraudel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-27 00:00:00.000000000 Z
+dependencies: []
+description: Sass API for type conversion.
+email:
+- hugo.giraudel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- CHANGELOG.md
+- lib/SassyCast.rb
+- stylesheets/SassyCast.scss
+- stylesheets/types/bool/_bool.scss
+- stylesheets/types/color/helpers/_from-hex.scss
+- stylesheets/types/color/helpers/_from-hsl.scss
+- stylesheets/types/color/helpers/_from-rgb.scss
+- stylesheets/types/color/helpers/_get-color-value.scss
+- stylesheets/types/color/helpers/_hex-to-dec.scss
+- stylesheets/types/color/_color.scss
+- stylesheets/types/list/_list.scss
+- stylesheets/types/map/_map.scss
+- stylesheets/types/null/_null.scss
+- stylesheets/types/number/helpers/_find-digits.scss
+- stylesheets/types/number/helpers/_find-integer.scss
+- stylesheets/types/number/helpers/_length.scss
+- stylesheets/types/number/helpers/_pow.scss
+- stylesheets/types/number/_number.scss
+- stylesheets/types/string/_string.scss
+homepage: https://github.com/HugoGiraudel/SassyCast/
+licenses: []
+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: 1.3.6
+requirements: []
+rubyforge_project: SassyCast
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: SassyCast is a Sass-powered API for type conversion.
+test_files: []