flint-gs 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91e892c1fbbf7d16348da8612ab5bc2111aeb00f
-  data.tar.gz: 23ab03f35aaf8a91c8854739812e474e154d016e
+  metadata.gz: 95fa317058ad844a74cbbf2ff08163f19c7023ad
+  data.tar.gz: 62700564e898e68da19ce762a7f89560cb59429b
 SHA512:
-  metadata.gz: 0904c66d96488e60afb4d3d2d8cebe7e7a51b90c6b56a7de4e4f1db7ded661160e29a7dd0c2b5ed1b8e53f840a6c5791b5647566b0cf4c298823b42e3f701603
-  data.tar.gz: dd8eb956a5495335c64701d5445fa58b0feb00d1a7bca50a713c47deb38b0ceb0fb15afc81a9e79e0284abfa59f9dcc5b40eb76ebec5034b38256b32ef5e0a63
+  metadata.gz: 7751705093073a2812b4f492041ee8fdae176d543e77a4a86f4c86320c1cb9f56b93d1c5149ca0bb39ac23dd4be04582e2ef5c7744b1d075642fa3a246ff9236
+  data.tar.gz: 867230aeb048f0d6eb01d6ec1f143ffd7e543bcbf37e6c26f49599c4085cbe0b859848e766006d31f924e9e87f66f148a910a083d562d0b724d2400505dfffcf

data/lib/flint.rb

@@ -10,8 +10,8 @@ else
 end
 
 module Flint
-    VERSION = "2.0.1"
-    DATE = "2014-09-25"
+    VERSION = "2.0.2"
+    DATE = "2014-10-01"
 end
 
 module Sass::Script::Functions
@@ -26,29 +26,46 @@ module Sass::Script::Functions
     end
 
     ###
-    # Turns string into a flat list
+    # Fetch value from map
     #
-    # @param {String} string    - string
+    # @param {Map}     map  - map to fetch value from
+    # @param {ArgList} keys - list of keys to traverse
+    #
+    # @return {String | False}
+    ###
+    def flint_ruby_map_fetch(map, *keys)
+        assert_type map, :Map, :map
+        result = map
+        keys.each {|key| result != nil ? result = result.to_h.fetch(key, nil) : break}
+        return result != nil ? result : Sass::Script::Bool.new(false)
+    end
+    declare :flint_ruby_map_fetch, :args => [:map, :keys], :var_args => true
+
+    ###
+    # Turn string into a flat list
+    #
+    # @param {String} string    - string to operate on
     # @param {String} separator - item to find which separates substrings
     # @param {String} ignore    - removes remaining string beyond item
     #
     # @return {List}
     ###
-    def string_to_list(string, separator, ignore)
-        # Remove rest of string after ignore
-        ignore = string.value[/[^#{ignore}]+/]
-        # Get first set of strings, convert to array by separator
-        items = ignore.split(separator.value)
-        # Convert array to list
+    def flint_ruby_string_to_list(string, separator, ignore)
+        assert_type string, :String, :string
+        assert_type separator, :String, :separator
+        assert_type ignore, :String, :ignore
+        # Remove everything after ignore, split with separator
+        items = string.value[/[^#{ignore}]+/].split(separator.value)
         if items.count == 1
             Sass::Script::String.new(items[0], :comma)
         else
             Sass::Script::List.new(items.map { |i| Sass::Script::String.new(i) }, :comma)
         end
     end
+    declare :flint_ruby_string_to_list, :args => [:string, :separator, :ignore]
 
     ###
-    # Replace substring
+    # Replace substring with string
     #
     # @param {String} string  - string that contains substring
     # @param {String} find    - substring to replace
@@ -56,11 +73,12 @@ module Sass::Script::Functions
     #
     # @return {String}
     ###
-    def replace_substring(string, find, replace)
+    def flint_ruby_replace_substring(string, find, replace)
+        assert_type string, :String, :string
+        assert_type find, :String, :find
+        assert_type replace, :String, :replace
         Sass::Script::String.new(string.value.gsub(find.value, replace.value))
     end
-
-    declare :string_to_list, [:string, :separator, :ignore]
-    declare :replace_substring, [:string, :find, :replace]
+    declare :flint_ruby_replace_substring, :args => [:string, :find, :replace]
 
 end

data/stylesheets/flint/config/_config.scss

@@ -1,10 +1,13 @@
 /**
  * Configuration map
  *
+ * @type Map
+ *
  * @prop {Map}    breakpoints                  - map of breakpoints, follow DSC order
  * @prop {Map}    breakpoints.alias            - named map of breakpoint settings
  * @prop {Number} breakpoints.alias.columns    - column count for breakpoint
  * @prop {Number} breakpoints.alias.breakpoint - breakpoint value for breakpoint
+ *
  * @prop {Map}    settings                     - map of settings for grid
  * @prop {String} settings.default             - alias of breakpoint to be grid default
  * @prop {String} settings.grid                - type of grid

data/stylesheets/flint/functions/lib/_instance.scss

@@ -39,5 +39,5 @@
 		)
     );
 
-    @return map-merge($flint__instances, $flint__instance);
+    @return map-merge($flint__instance, $flint__instances);
 }

data/stylesheets/flint/functions/lib/_map-fetch.scss

@@ -9,11 +9,21 @@
  * @return {String | False}
  */
 @function flint-map-fetch($map, $keys...) {
-	$result: $map;
 
-	@each $key in $keys {
-		$result: flint-is-map($result) and map-has-key($result, $key) and map-get($result, $key) or false;
-	}
+	// Use Ruby function if available
+	@if $flint__use-ruby-functions {
+		@return flint_ruby_map_fetch($map, $keys...);
+	} @else {
+		$result: $map;
+
+		@each $key in $keys {
+			@if $result {
+				$result: flint-is-map($result) and map-has-key($result, $key) and map-get($result, $key) or false;
+			} @else {
+				@return false;
+			}
+		}
 
-	@return $result;
+		@return $result;
+	}
 }

data/stylesheets/flint/functions/lib/_replace-substring.scss

@@ -13,7 +13,7 @@
 
 	// Use Ruby function if available
 	@if $flint__use-ruby-functions {
-		@return replace_substring($string, $substring, $new-substring);
+		@return flint_ruby_replace_substring($string, $substring, $new-substring);
 	} @else {
 		// Loop through length of string
 		@for $i from 1 through str-length($string) {

data/stylesheets/flint/functions/lib/_string-to-list.scss

@@ -3,7 +3,7 @@
  *
  * @access private
  *
- * @param {String} $string
+ * @param {String} $string       - string to perform on
  * @param {String} $find   (" ") - item to find which separates substrings
  * @param {String} $ignore (",") - removes remaining string beyond item
  *
@@ -14,7 +14,7 @@
 
 		// Use Ruby function if available
 		@if $flint__use-ruby-functions {
-			@return string_to_list($string, $find, $ignore);
+			@return flint_ruby_string_to_list($string, $find, $ignore);
 		} @else {
 			$string-list: ();
 			$space-indexes: ();

data/stylesheets/flint/functions/lib/_support-syntax.scss

@@ -12,13 +12,11 @@
     $syntax: to-lower-case($syntax);
 
     // Make sure syntax is supported
-    // ----
     @if function-exists("flint-support-syntax-#{$syntax}") {
 
         // Support syntax
-        // ----
-        // @warning : be sure you have created a custom function to support an unknown syntax
-        // ----
+        //
+        // WARNING: Be sure you have created a custom function to support an unknown syntax
         @return call("flint-support-syntax-#{$syntax}", $selectors);
 
     } @else {

data/stylesheets/flint/functions/lib/_types-in-list.scss

@@ -13,11 +13,9 @@
     @if flint-is-list($list) {
 
         // Assert types in list?
-        // ----
         @if $assert-types {
 
             // Assert length of list?
-            // ----
             @if $assert-length {
                 // Get length of list
                 $length: length($list);
@@ -28,11 +26,9 @@
                     $types: ();
 
                     // List of asserted types?
-                    // ----
                     @if flint-is-list($assert-types) {
 
                         // Make sure length of types match list
-                        // ----
                         @if length($assert-types) == $length {
 
                             // Loop over each item in list
@@ -49,13 +45,11 @@
                             }
 
                         // Lengths did not match
-                        // ----
                         } @else {
                             @return false;
                         }
 
                     // Assert a single type across list
-                    // ----
                     } @else {
                         // Assert single type
                         $type: nth($assert-types, 1);
@@ -82,7 +76,6 @@
                 }
 
             // Just assert types in list, any length
-            // ----
             } @else {
                 // Get asserted type
                 $type: $assert-types;
@@ -100,7 +93,6 @@
             }
 
         // Just assert type of first item in list
-        // ----
         } @else {
             // Get type of first item in list
             $type: type-of(nth($list, 1));
@@ -115,6 +107,7 @@
 
             @return true;
         }
+
     // Was not a list, return false
     } @else {
         @return false;

data/stylesheets/flint/globals/_globals.scss

@@ -1,100 +1,100 @@
-/*
+/**
  * Use development mode to silence fatal errors
  *
  * @access private
  *
- * @type {Bool}
+ * @type Bool
  */
 $flint__development-mode: false !global;
 
-/*
+/**
  * Set global variable to check if foundation has been set
  *
  * @access private
  *
- * @type {String}
+ * @type String
  */
 $flint__foundation: "non-existent" !global;
 
-/*
- * Gather all keys, breakpoints and column counts
- *
- * @access private
- *
- * @type {List}
- */
-$flint__all-keys: flint-get-all-keys() !global;
-$flint__all-breakpoints: flint-get-all-breakpoints() !global;
-$flint__all-columns: flint-get-all-columns() !global;
-
-/*
+/**
  * Keep count of all instances
  *
  * @access private
  *
- * @type {Number}
+ * @type Number
  */
 $flint__instance-count: 0 !global;
 
-/*
+/**
  * Keep map of all instances
  *
  * @access private
  *
- * @type {Map}
+ * @type Map
  */
 $flint__instances: () !global;
 
-/*
+/**
  * Font size for em calculation
  *
  * @access private
  *
- * @type {Number}
+ * @type Number
  */
 $flint__base-font-size: 16px !global;
 
-/*
+/**
+ * Detect if Ruby functions are available
+ *
+ * @access private
+ *
+ * @type Bool
+ */
+$flint__use-ruby-functions: if(flint-use-ruby-functions() == true, true, false) !global;
+
+/**
  * Global syntax support
  *
  * @access private
  *
- * @type {String}
+ * @type String
  */
 $flint__support-syntax: flint-get-value("settings", "support-syntax") !global;
 
-/*
- * Detect if Ruby functions are available
+/**
+ * Gather all keys, breakpoints and column counts
  *
  * @access private
  *
- * @type {Bool}
+ * @type List
  */
-$flint__use-ruby-functions: if(flint-use-ruby-functions() == true, true, false) !global;
+$flint__all-keys: flint-get-all-keys() !global;
+$flint__all-breakpoints: flint-get-all-breakpoints() !global;
+$flint__all-columns: flint-get-all-columns() !global;
 
-/*
+/**
  * Cache selector instance lists
  *
  * @access private
  *
- * @type {Map}
+ * @type Map
  */
 $flint__cached-instances: () !global;
 
-/*
+/**
  * Cache calculated values
  *
  * @access private
  *
- * @type {Map}
+ * @type Map
  */
 $flint__cached-values: () !global;
 
-/*
+/**
  * Cache calculation results
  *
  * @access private
  *
- * @type {Map}
+ * @type Map
  */
 $flint__cache-results: () !global;

data/stylesheets/flint/mixins/lib/_main.scss

@@ -8,6 +8,78 @@
  * @param {String | Number | List} $context - context value of span
  * @param {String | List}          $gutter  - alias for gutter modifier
  *
+ * @throws error if list lengths do not match number of breakpoints
+ *
+ * @example scss - Clearfix
+ * _(clear)
+ *
+ * @example scss - Foundation
+ * _(foundation)
+ *
+ * @example scss - Container
+ * _(container)
+ *
+ * @example scss - Recursive shorthand with no context
+ * _(2)
+ *
+ * @example scss - Recursive shorthand with identical context
+ * _(2, 4)
+ *
+ * @example scss - Recursive shorthand with differing context
+ * _(1, 2 4 6 8)
+ * _(1, auto)
+ *
+ * @example scss - Variable shorthand with no context
+ * _(1 2 3 4)
+ *
+ * @example scss - Variable shorthand with identical context
+ * _(1 2 3 4, 4)
+ * _(1 2 3 4, auto)
+ *
+ * @example scss - Variable shorthand with differing context
+ * _(4 3 2 1, 8 6 4 2)
+ * _(4 3 2 1, auto)
+ *
+ * @example scss - Call by alias with no context
+ * _(desktop, 2)
+ *
+ * @example scss - Call by alias with context
+ * _(desktop, 2, 4)
+ * _(desktop, 2, auto)
+ *
+ * @example scss - Call $key breakpoint by alias
+ * _($key)
+ *
+ * @example scss - From $key breakpoint to infinity
+ * _(from $key to infinity)
+ *
+ * @example scss - From $key-x breakpoint to $key-y breakpoint
+ * _(from $key-x to $key-y)
+ *
+ * @example scss - From $num-x to $num-y
+ * _(from $num-x to $num-y)
+ *
+ * @example scss - Greater than $key breakpoint
+ * _(greater than $key)
+ *
+ * @example scss - Greater than number
+ * _(greater than $num)
+ *
+ * @example scss - Number greater than $key breakpoint
+ * _($num greater than $key)
+ *
+ * @example scss - Less than $key breakpoint
+ * _(less than $key)
+ *
+ * @example scss - Less than number
+ * _(less than $num)
+ *
+ * @example scss - Number less than $key breakpoint
+ * _($num less than $key)
+ *
+ * @example scss - For $key-x $key-y $key-z
+ * _(for $key-x $key-y $key-z)
+ *
  * @author Ezekiel Gabrielse
  * @link http://flint.gs
  */
@@ -18,15 +90,8 @@
     $gutter: null
 ) {
 
-    /**
-     * Clearfix instance
-     *   Uses `clearfix` mixin if one already exists,
-     *   else falls back to packaged.
-     *
-     * @param {String}
-     *
-     * @example scss
-     * _(clear)
+    /*
+     * Clearfix
      */
     @if $key == "clear" or $span == "clear" or $context == "clear" {
 
@@ -70,15 +135,8 @@
         }
     }
 
-    /**
-     * Foundation instance
-     *   Uses `box-sizing` mixin if one already exists,
-     *   else falls back to packaged.
-     *
-     * @param {String}
-     *
-     * @example scss
-     * _(foundation)
+    /*
+     * Foundation
      */
     @if $key == "foundation" {
 
@@ -97,13 +155,8 @@
             }
         }
 
-    /**
-     * Container instance
-     *
-     * @param {String}
-     *
-     * @example scss
-     * _(container)
+    /*
+     * Container
      */
     } @else if $key == "container" or $span == "container" or $context == "container" {
 
@@ -209,78 +262,36 @@
             @include _("foundation");
         }
 
-        /**
+        /*
          * Recursive shorthand with no context
-         *
-         * @param {Number} $key  - single span value for all breakpoints
-         * @param {Null}   $span - null context value
-         *
-         * @example scss
-         * _(2)
          */
         @if flint-is-number($key) and length($key) == 1 and $span == null
 
-        /**
+        /*
          * Recursive shorthand with identical context
-         *
-         * @param {Number}          $key  - single span value for all breakpoints
-         * @param {Number | String} $span - single context value for all breakpoints
-         *
-         * @example scss
-         * _(2, 4)
          */
         or flint-is-number($key) and length($key) == 1 and flint-is-number($span) and length($span) == 1
         or flint-is-number($key) and length($key) == 1 and $span == "auto"
 
-        /**
+        /*
          * Recursive shorthand with differing context
-         *
-         * @param {Number}        $key  - single span value for all breakpoints
-         * @param {List | String} $span - context value of span for each breakpoint
-         *
-         * @example scss
-         * _(1, 2 4 6 8) | _(1, auto)
-         *
-         * @throws error if lengths do not match number of breakpoints
          */
         or flint-is-number($key) and length($key) == 1 and flint-types-in-list($span, "number")
         or flint-is-number($key) and length($key) == 1 and $span == "auto"
 
-        /**
+        /*
          * Variable shorthand with no context
-         *
-         * @param {List} $key  - span value for each breakpoint
-         * @param {Null} $span - null context value
-         *
-         * @example scss
-         * _(1 2 3 4)
-         *
-         * @throws error if lengths do not match number of breakpoints
          */
         or flint-types-in-list($key, "number") and $span == null
 
-        /**
+        /*
          * Variable shorthand with identical context
-         *
-         * @param {List}            $key  - span value for each breakpoint
-         * @param {Number | String} $span - context value for each breakpoint
-         *
-         * @example scss
-         * _(1 2 3 4, 4) | _(1 2 3 4, auto)
          */
         or flint-types-in-list($key, "number") and flint-is-number($span) and length($span) == 1
         or flint-types-in-list($key, "number") and $span == "auto"
 
-        /**
+        /*
          * Variable shorthand with differing context
-         *
-         * @param {List}          $key  - span value for each breakpoint
-         * @param {List | String} $span - context value for each breakpoint
-         *
-         * @example scss
-         * _(4 3 2 1, 8 6 4 2) | _(4 3 2 1, auto)
-         *
-         * @throws error if lengths do not match number of breakpoints
          */
         or flint-types-in-list($key, "number") and flint-types-in-list($span, "number")
         or flint-types-in-list($key, "number") and $span == "auto" {
@@ -360,36 +371,18 @@
                 }
             }
 
-        /**
+        /*
          * Call by alias with no context
-         *
-         * @param {String} $key     - breakpoint alias
-         * @param {Number} $span    - span value for breakpoint
-         * @param {Null}   $context - null context value
-         *
-         * @example scss
-         * _(desktop, 2)
-         *
-         * @throws error if breakpoint alias does not exist
          */
         } @else if flint-is-string($key) and flint-is-number($span) and $context == null
 
-        /**
+        /*
          * Call by alias with context
-         *
-         * @param {String}          $key     - breakpoint alias
-         * @param {Number}          $span    - span value for breakpoint
-         * @param {Number | String} $context - context value for breakpoint
-         *
-         * @example scss
-         * _(desktop, 2, 4) | _(desktop, 2, auto)
-         *
-         * @throws error if breakpoint alias does not exist
          */
         or flint-is-string($key) and flint-is-number($span) and flint-is-number($context)
         or flint-is-string($key) and flint-is-number($span) and $context == "auto" {
 
-            // Emit erroring for invalid argument lengths
+            // Throw error for invalid argument lengths
             @if not flint-exists($flint, $key) {
                 @if not $flint__development-mode {
                     @error "Invalid argument: #{$key}. Breakpoint does not exist. Please provide a valid argument.";
@@ -457,21 +450,14 @@
                 }
             }
 
-        /**
-         * Wrap @content in media query
-         *
-         * @param {String | List} $key - defines how to make up media query
+        /*
+         * Wrap content in media query
          */
         } @else if flint-exists($flint, $key) and $span == null and $context == null
         or flint-is-list($key) and $span == null and $context == null {
 
-            /**
+            /*
              * Call $key breakpoint by alias
-             *
-             * @param {String} $key - only for $key breakpoint
-             *
-             * @example scss
-             * _($key)
              */
             @if length($key) == 1 {
 
@@ -501,13 +487,8 @@
                     }
                 }
 
-            /**
+            /*
              * From $key breakpoint to infinity
-             *
-             * @param {List} $key - min-width from $key breakpoint
-             *
-             * @example scss
-             * _(from $key to infinity)
              */
             } @else if flint-types-in-list($key, "string", 4) and nth($key, 1) == "from" and nth($key, 3) == "to" and nth($key, 4) == "infinity" {
 
@@ -525,13 +506,8 @@
                     }
                 }
 
-            /**
+            /*
              * From $key-x breakpoint to $key-y breakpoint
-             *
-             * @param {List} $key - from $key-x breakpoint to $key-y
-             *
-             * @example scss
-             * _(from $key-x to $key-y)
              */
             } @else if flint-types-in-list($key, "string", 4) and nth($key, 1) == "from" and nth($key, 3) == "to" {
 
@@ -549,13 +525,8 @@
                     }
                 }
 
-            /**
+            /*
              * From $num-x to $num-y
-             *
-             * @param {List} $key - arbitrary media query
-             *
-             * @example scss
-             * _(from $num-x to $num-y)
              */
             } @else if flint-types-in-list($key, "string" "number" "string" "number", 4) and nth($key, 1) == "from" and nth($key, 3) == "to" {
                 // Make sure passed units match units used in config
@@ -570,13 +541,8 @@
                     }
                 }
 
-            /**
+            /*
              * Greater than $key breakpoint
-             *
-             * @param {List} $key - anything above $key breakpoint
-             *
-             * @example scss
-             * _(greater than $key)
              */
             } @else if flint-types-in-list($key, "string", 3) and nth($key, 1) == "greater" and nth($key, 2) == "than" {
 
@@ -594,13 +560,8 @@
                     }
                 }
 
-            /**
+            /*
              * Greater than number
-             *
-             * @param {List} $key - anything above number
-             *
-             * @example scss
-             * _(greater than $num)
              */
             } @else if flint-types-in-list($key, "string" "string" "number", 3) and nth($key, 1) == "greater" and nth($key, 2) == "than" {
 
@@ -614,13 +575,8 @@
                     }
                 }
 
-            /**
+            /*
              * Number greater than $key breakpoint
-             *
-             * @param {List} $key - unit value greater than $key breakpoint
-             *
-             * @example scss
-             * _($num greater than $key)
              */
             } @else if flint-types-in-list($key, "number" "string" "string" "string", 4) and nth($key, 2) == "greater" and nth($key, 3) == "than" {
 
@@ -634,13 +590,8 @@
                     }
                 }
 
-            /**
+            /*
              * Less than $key breakpoint
-             *
-             * @param {List} $key - anything below $key breakpoint
-             *
-             * @example scss
-             * _(less than $key)
              */
             } @else if flint-types-in-list($key, "string", 3) and nth($key, 1) == "less" and nth($key, 2) == "than" {
 
@@ -658,13 +609,8 @@
                     }
                 }
 
-            /**
+            /*
              * Less than number
-             *
-             * @param {List} $key - anything below number
-             *
-             * @example scss
-             * _(less than $num)
              */
             } @else if flint-types-in-list($key, "string" "string" "number", 3) and nth($key, 1) == "less" and nth($key, 2) == "than" {
 
@@ -678,13 +624,8 @@
                     }
                 }
 
-            /**
+            /*
              * Number less than $key breakpoint
-             *
-             * @param {List} $key - unit value less than $key breakpoint
-             *
-             * @example scss
-             * _($num less than $key)
              */
             } @else if flint-types-in-list($key, "number" "string" "string" "string", 4) and nth($key, 2) == "less" and nth($key, 3) == "than" {
 
@@ -698,13 +639,8 @@
                     }
                 }
 
-            /**
+            /*
              * For $key-x $key-y $key-z
-             *
-             * @param {List} $key - comma delimited list of queries
-             *
-             * @example scss
-             * _(for $key-x $key-y $key-z)
              */
             } @else if flint-types-in-list($key, "string") and nth($key, 1) == "for" {
                 // Define empty query list
@@ -748,10 +684,8 @@
                 }
             }
 
-        /**
+        /*
          * Invalid argument
-         *
-         * @throw invalid argument error
          */
         } @else {
             @if $key != "clear" {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flint-gs
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Ezekiel Gabrielse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-25 00:00:00.000000000 Z
+date: 2014-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sass