SassyCast 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4770cd04049b0257d92291e040aaebe64e28ecad
-  data.tar.gz: 166fce1bcd86158f1b2304e4057ac43705fbd027
+  metadata.gz: 4f42a0fe044be49a40d427fe6af9cdc0fa60639a
+  data.tar.gz: 8a4c35110c665195d42761ae5a9aa389ea86bb5f
 SHA512:
-  metadata.gz: 8b118cf974c1a739297ad915521d36fc182d3f139eb1a24ff32d75cd01b244f879125a7d37d270838560a44dc628556f913ded32d08b90b23e68938ba2e65eba
-  data.tar.gz: 7de8734df558b6079ef63f840bd9fd0c67ada77a24ace850ea47937ed1b262f670f7733c05355d308998a632ca1daf749b413154e218fa9444d3bdf345a998ad
+  metadata.gz: bf461c41c1d0a48c9496a755996edff6ced8011b14541e7708968a46027cbcaf2dab57d15fe1d9971948bcd3d4818bc1f65184f46267b09c2b5bc88cec3cb6ea
+  data.tar.gz: e16b8b9828b79152b02b54f697e51a39b9ccaed02fd0526023c8de3646a84aff6528e78cf876e38337f44524c4f9aa0cf4fbe4eefc798aca5af19df0cc7e57b6

data/CHANGELOG.md

@@ -1,3 +1,4 @@
 # Changelog
 
+* `1.0.0`: `to-list` improvements, stable API
 * `0.0.1`: initial commit

data/lib/SassyCast.rb

@@ -5,8 +5,8 @@ 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"
+  VERSION = "1.0.0"
+  DATE = "2014-01-31"
 end
 
 module Sass::Script::Functions

data/stylesheets/types/color/_color.scss

@@ -1,3 +1,5 @@
+// Helpers
+
 @import "helpers/from-rgb";
 @import "helpers/from-hsl";
 @import "helpers/from-hex";

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

@@ -1,3 +1,9 @@
+// Cast a string into a hexadecimal color
+// --------------------------------------------------------------------------------
+// @param [string] $string: string
+// --------------------------------------------------------------------------------
+// @return [color|string] string or hex color depending on the match
+
 @function _from-hex($string) {
   $string-lower: to-lower-case($string);
   $r: "";  $g: ""; $b: "";

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

@@ -1,3 +1,9 @@
+// Cast a string into a hsl color
+// --------------------------------------------------------------------------------
+// @param [string] $string: string
+// --------------------------------------------------------------------------------
+// @return [color|string] string or hsl color depending on the match
+
 @function _from-hsl($string) {
   $frags: ();
   $string-lower: to-lower-case($string);

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

@@ -1,3 +1,9 @@
+// Cast a string into a rgb color
+// --------------------------------------------------------------------------------
+// @param [string] $string: string
+// --------------------------------------------------------------------------------
+// @return [color|string] string or rgb color depending on the match
+
 @function _from-rgb($string) {
   $string-lower: to-lower-case($string);
   $frags: ();

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

@@ -1,3 +1,9 @@
+// Cast a stringified number / stringified percentage into number type
+// --------------------------------------------------------------------------------
+// @param [string] $string: string
+// --------------------------------------------------------------------------------
+// @return [number] unitless number or percentage
+
 @function _get-color-value($string) {
   $first: str-slice($string, 1, 1);
 

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

@@ -1,3 +1,9 @@
+// Convert an hexadecimal number to a decimal number
+// --------------------------------------------------------------------------------
+// @param [string] $string: hexadecimal value
+// --------------------------------------------------------------------------------
+// @return [number] decimal number
+
 @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);

data/stylesheets/types/list/_list.scss

@@ -4,7 +4,9 @@
 // --------------------------------------------------------------------------------
 // @return [list]
 
-@function to-list($value) {
+@function to-list($value, $keep: 'both') {
+  $keep: if(index('keys' 'values' 'both', $keep), $keep, 'both');
+  
   @if type-of($value) == map {
     $keys: ();
     $values: ();
@@ -12,7 +14,16 @@
       $keys: append($keys, $key);
       $values: append($values, $val);
     }
-    @return zip($keys, $values);
+
+    @if $keep == 'keys' {
+      @return $keys;
+    }
+    @else if $keep == 'values' {
+      @return $values;
+    }
+    @else {
+      @return zip($keys, $values);
+    }
   }
 
   @return if(type-of($value) != list, ($value,), $value);

data/stylesheets/types/number/_number.scss

@@ -1,64 +1,66 @@
+// Helpers
+
 @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
+// Cast a value to a number if possible or return 0
 // --------------------------------------------------------------------------------
-// @throw "Unexpected token $token."
-// @throw "Unexpected end of stream."
+// @param [string] $value: complete source
 // --------------------------------------------------------------------------------
-// @return [list|false] (new pointer, parsed number)
+// @return [number] number (0 if cast failed)
 
-@function to-number($source) {
-  @if type-of($source) == number {
-    @return $source;
+@function to-number($value) {
+  // In case everything's good
+  @if type-of($value) == number {
+    @return $value;
   }
 
-  @if $source == true  {
+  // Boolean to number
+  @if $value == true  {
     @return 1;
   }
 
-  @if type-of($source) != string {
+  // Fail
+  @if type-of($value) != 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($source, $pointer, $pointer); // First character of the number
+  $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($source)} into number.";
+    @warn "Could not cast `#{inspect($value)} into number.";
     @return 0;
   }
 
   // Find the integer part
-  $find-integer: _find-integer($source, $pointer);
+  $find-integer: _find-integer($value, $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);
+  @if str-slice($value, $pointer, $pointer) == '.' {
+    $find-digits: _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;
   }
 
-
-//  @return $result $pointer str-length($source);
-  @if $pointer < str-length($source) {
-    $result: _length($result, str-slice($source, $pointer));
+  // In case of possible CSS unit
+  @if $pointer < str-length($value) {
+    $result: _length($result, str-slice($value, $pointer));
   }
 
   @return $result;

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

@@ -1,11 +1,9 @@
-// Parses a JSON encoded number to find the digits
+// Finding the digits part of a stringified number
 // --------------------------------------------------------------------------------
-// @param [string] $source: JSON complete source
+// @param [string] $source: string source
 // @param [number] $pointer: current pointer
 // --------------------------------------------------------------------------------
-// @throw "Unexpected token $token."
-// --------------------------------------------------------------------------------
-// @return [list|false] (new pointer, parsed number)
+// @return [list] (new pointer, parsed number)
 
 @function _find-digits($source, $pointer) {
   $source: to-lower-case($source);

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

@@ -1,11 +1,9 @@
-// Parses a JSON encoded number to find the integer part
+// Finding the integer part of a stringified number
 // --------------------------------------------------------------------------------
-// @param [string] $source: JSON complete source
+// @param [string] $source: string source
 // @param [number] $pointer: current pointer
 // --------------------------------------------------------------------------------
-// @throw "Unexpected token $token."
-// --------------------------------------------------------------------------------
-// @return [list|false] (new pointer, parsed number)
+// @return [list] (new pointer, parsed number)
 
 @function _find-integer($source, $pointer) {
   $source: to-lower-case($source);
@@ -18,7 +16,7 @@
     $index: index($numbers, $token);
 
     @if $token == '-' {
-      // do nothing
+      // @continue;
     }
     @else if $index {
       $result: $result * 10 + ($index - 1);

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

@@ -1,3 +1,10 @@
+// Tries to find a unit that would match a CSS length
+// --------------------------------------------------------------------------------
+// @param [number] $number: number
+// @param [unit] $unit: potential unit
+// --------------------------------------------------------------------------------
+// @return [number] length (0 if cast failed)
+
 @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;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: SassyCast
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Hugo Giraudel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-27 00:00:00.000000000 Z
+date: 2014-01-31 00:00:00.000000000 Z
 dependencies: []
 description: Sass API for type conversion.
 email: