flint-gs 1.12.0 → 2.0.0.rc.1

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

@@ -1,10 +1,11 @@
-// Check if key exists in map
-//--------------------------------------------------------------------------------
-// @param $map [map] : map that contains $value
-// @param $value [string] : key to search for
-// -------------------------------------------------------------------------------
-// @return [bool]
-
+/**
+ * Check if key exists in map
+ *
+ * @param {Map}    $map   - map to search
+ * @param {Strong} $value - key to search for
+ *
+ * @return {Bool}
+ */
 @function flint-exists($map, $value){
 	$is-map: flint-is-map($map);
 	$top-has-key: $is-map and map-has-key($map, $value) or false;

data/stylesheets/flint/functions/lib/_fluid-width.scss

@@ -1,10 +1,11 @@
-// Convert fixed to fluid width
-//--------------------------------------------------------------------------------
-// @param $target [number] : target
-// @param $context [number] : context
-// -------------------------------------------------------------------------------
-// @return [number]
-
+/**
+ * Convert fixed to fluid width
+ *
+ * @param {Number} $target
+ * @param {Number} $context
+ *
+ * @return {Number}
+ */
 @function flint-fluid-width($target, $context) {
 	@return ($target / $context) * 100%;
 }

data/stylesheets/flint/functions/lib/_get-index.scss

@@ -1,14 +1,16 @@
-// Gets the index of the passed key
-// -------------------------------------------------------------------------------
-// @param $key [string] : breakpoint key
-// -------------------------------------------------------------------------------
-// @return [number]
-
+/**
+ * Gets the index of the passed key
+ *
+ * @param {String} $key - breakpoint key
+ *
+ * @return {Number}
+ */
 @function flint-get-index($key) {
-  	@for $i from 1 through (length(flint-map-fetch($flint, "config")) - 1) {
-		@if flint-steal-key($i) == $key {
-			@return $i;
-		}
+
+    @for $i from 1 through length(map-keys(flint-get-value("breakpoints"))) {
+        @if flint-steal-key($i) == $key {
+            @return $i;
+        }
 	}
 
     @return false;

data/stylesheets/flint/functions/lib/_get-instance-value.scss

@@ -1,17 +1,11 @@
-// Get single value from key in instance map based on $selector::$key
-// -------------------------------------------------------------------------------
-// @warning : all values returned are strings and must be converted with `flint-to-number()`
-// -------------------------------------------------------------------------------
-// @param $key [string] : key
-// @param $value [number] : value
-// @param $deep [number] : fetch deep value
-// -------------------------------------------------------------------------------
-// @return fetched literal | false
-
-@function flint-get-instance-value($key, $value, $deep: null) {
-	@if not $deep {
-		@return flint-map-fetch($flint__instances, flint-has-family-instance($key) $value);
-	} @else {
-		@return flint-map-fetch($flint__instances, flint-has-family-instance($key) $value $deep);
-	}
+/**
+ * Get single value from key in instance map based on $selector::$key
+ *
+ * @param {String}  $key    - breakpoint key to pass to instance method
+ * @param {ArgList} $values - list of keys to fetch value from
+ *
+ * @return {String | False}
+ */
+@function flint-get-instance-value($key, $values...) {
+	@return flint-map-fetch($flint__instances, flint-has-family-instance($key), $values...);
 }

data/stylesheets/flint/functions/lib/_get-value.scss

@@ -1,14 +1,10 @@
-// Get single value from key in instance map based on $selector::$key
-// -------------------------------------------------------------------------------
-// @param $key [string] : breakpoint key
-// @param $value [string] : key of value
-// -------------------------------------------------------------------------------
-// @return [literal]
-
-@function flint-get-value($key, $value: null) {
-	@if not $value {
-		@return flint-map-fetch($flint, "config" $key);
-	} @else {
-		@return flint-map-fetch($flint, "config" $key $value);
-	}
+/**
+ * Get single value from configuration map
+ *
+ * @param {ArgList} $keys - list of keys to fetch value from
+ *
+ * @return {*}
+ */
+@function flint-get-value($keys...) {
+	@return flint-map-fetch($flint, $keys...);
 }

data/stylesheets/flint/functions/lib/_has-family-instance.scss

@@ -1,17 +1,18 @@
-// Checks if instance flint-exists in selector familiy tree, falls back from current selector
-// -------------------------------------------------------------------------------
-// @param $key [string] : breakpoint key to search for matching instance
-// @param $syntax [string | null] : searches for instance using passed syntax
-// -------------------------------------------------------------------------------
-// @return matching instance | false
-
+/**
+ * Checks if instance flint-exists in selector familiy tree, falls back from current selector
+ *
+ * @param {String} $key    - breakpoint key to search for matching instance
+ * @param {String} $syntax - searches for instance using passed syntax parser
+ *
+ * @return {String | False} instance selector
+ */
 @function flint-has-family-instance($key: flint-get-value("settings", "default"), $syntax: $flint__support-syntax) {
-	$selector-string: selector_string();
+	$selector: nth(&, 1);
 
 	// Check if instance result had been cached
-	@if map-has-key($flint__cached-instances, "#{$selector-string}") {
+	@if map-has-key($flint__cached-instances, "#{$selector}") {
 		// Get cached instance
-		$cached-instance: map-get($flint__cached-instances, "#{$selector-string}");
+		$cached-instance: map-get($flint__cached-instances, "#{$selector}");
 		// Return with current key
 		@return "#{$cached-instance}::#{$key}";
 	}
@@ -19,25 +20,25 @@
 	// Check for syntax support, try to find instance using it
 	@if $syntax {
 
-		$selector-list: flint-use-syntax($selector-string);
-		$length: length($selector-list);
+		$parsed-selector: flint-use-syntax($selector);
+		$length: length($parsed-selector);
 
 		// Loop through transformed selectors
 		@for $i from 1 through $length {
 
 			// Check flint-last selector in list
-			@if flint-exists($flint__instances, "#{flint-last($selector-list)}::#{$key}") {
+			@if flint-exists($flint__instances, "#{flint-last($parsed-selector)}::#{$key}") {
 
 				// Cache result
-				$flint__cached-instances: map-merge($flint__cached-instances, ("#{$selector-string}": "#{flint-last($selector-list)}"));
+				$flint__cached-instances: map-merge($flint__cached-instances, ("#{$selector}": "#{flint-last($parsed-selector)}"));
 
 				// Return the matching instance key
-				@return "#{flint-last($selector-list)}::#{$key}";
+				@return "#{flint-last($parsed-selector)}::#{$key}";
 
 			} @else {
 
 				// Else, flint-remove the flint-last selector and loop again
-				$selector-list: flint-remove($selector-list, flint-last($selector-list));
+				$parsed-selector: flint-remove($parsed-selector, flint-last($parsed-selector));
 
 			}
 		}
@@ -46,17 +47,17 @@
 		@return flint-has-family-instance($key, null);
 
 	} @else {
-		$selector-list: flint-string-to-list($selector-string);
+		$selector-list: $selector;
 		$length: length($selector-list);
 
 		// Loop through length of list of selectors
 		@for $i from 1 through $length {
 
-			// Make sure that we're not counting the current selector string
-			@if flint-exists($flint__instances, "#{flint-list-to-string($selector-list, ' ')}::#{$key}") and $selector-string != flint-list-to-string($selector-list, " ") {
+			// Make sure that we're not counting the current selector set
+			@if flint-exists($flint__instances, "#{flint-list-to-string($selector-list, ' ')}::#{$key}") and $selector != $selector-list {
 
 				// Cache result
-				$flint__cached-instances: map-merge($flint__cached-instances, ("#{$selector-string}": "#{flint-list-to-string($selector-list, ' ')}"));
+				$flint__cached-instances: map-merge($flint__cached-instances, ("#{$selector}": "#{flint-list-to-string($selector-list, ' ')}"));
 
 				// Return the matching instance key
 				@return "#{flint-list-to-string($selector-list, ' ')}::#{$key}";

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

@@ -1,38 +1,35 @@
-// Keeps count of all instances with arguments, stores in global var
-// -------------------------------------------------------------------------------
-// @param $key [string] : computed breakpoint of instance
-// @param $span [number] : computed span of instance
-// @param $context [number] : computed context of instance
-// @param $gutter [number] : computed gutter of instance
-// @param $shift [number] : computed shift of instance
-// @param $output-width [number] : computed width of instance
-// @param $output-margin-right [number] : computed right margin of instance
-// @param $output-margin-left [number] : computed left margin of instance
-// -------------------------------------------------------------------------------
-// @return instance map
-
-@function flint-instance($key, $span, $context, $gutter, $shift, $output-width, $output-margin-right, $output-margin-left) {
+/**
+ * Keeps count of all instances with arguments, stores in global var
+ *
+ * @param {String} $key                 - computed breakpoint of instance
+ * @param {Number} $span                - computed span of instance
+ * @param {Number} $context             - computed context of instance
+ * @param {Number} $gutter              - computed gutter of instance
+ * @param {Number} $output-width        - computed width of instance
+ * @param {Number} $output-margin-right - computed right margin of instance
+ * @param {Number} $output-margin-left  - computed left margin of instance
+ *
+ * @return {Map} merged instance map
+ */
+@function flint-instance($key, $span, $context, $gutter, $output-width, $output-margin-right, $output-margin-left) {
 
     // Increase the instance count
     $flint__instance-count: $flint__instance-count + 1 !global;
 
     // Lets clean up the selector a bit...
-    $selector-string: selector_string();
-    $selector-list: flint-string-to-list($selector-string);
-    $selector-cleaned: flint-list-to-string($selector-list, " ");
+    $selector: nth(&, 1);
 
     $flint__instance: (
-		"#{$selector-cleaned}::#{$key}": (
+		"#{$selector}::#{$key}": (
 			"instance-count": $flint__instance-count,
 			"parent-selector": if(flint-has-family-instance($key) != false, flint-has-family-instance($key), none),
 			"key": $key,
-			"breakpoint": flint-get-value($key, "breakpoint"),
-			"columns": flint-get-value($key, "columns"),
+			"breakpoint": flint-get-value("breakpoints", $key, "breakpoint"),
+			"columns": flint-get-value("breakpoints", $key, "columns"),
 			"span": $span,
 			"context": if($context == "auto", flint-get-instance-value($key, "span"), $context),
 			"gutter": $gutter,
-			"shift": $shift,
-			"output": (
+			"internal": (
 				"width": $output-width,
 				"margin-right": $output-margin-right,
 				"margin-left": $output-margin-left

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

@@ -1,9 +1,10 @@
-// Get last item in list
-// -------------------------------------------------------------------------------
-// @param $list [list] : list
-// -------------------------------------------------------------------------------
-// @return [list]
-
+/**
+ * Get last item in list
+ *
+ * @param {List} $list
+ *
+ * @return {List}
+ */
 @function flint-last($list) {
 	@return nth($list, length($list));
 }

data/stylesheets/flint/functions/lib/_list-to-string.scss

@@ -1,12 +1,14 @@
-// Joins all elements of $list with $glue
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation/#to-string
-// -------------------------------------------------------------------------------
-// @param $list [list] : list
-// @param $glue [string] : value to use as a join string
-// -------------------------------------------------------------------------------
-// @return [string]
-
+/**
+ * Joins all elements of list with passed glue
+ *
+ * @link http://sassylists.com/documentation/#to-string
+ *
+ * @param {List}   $list
+ * @param {String} $glue
+ * @param {Bool}   $is-nested
+ *
+ * @return {String}
+ */
 @function flint-list-to-string($list, $glue: "", $is-nested: false) {
 	$result: null;
 	$length: length($list);

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

@@ -1,23 +1,17 @@
-// Fetch value from key in map
-// -------------------------------------------------------------------------------
-// @param $map [map] : map to fetch from
-// @param $keys [string | list] : string of key, or list of strings
-// -------------------------------------------------------------------------------
-// @return fetched literal | false
+/**
+ * Fetch value from map
+ *
+ * @param {Map}     $map  - map to fetch value from
+ * @param {ArgList} $keys - list of keys to traverse
+ *
+ * @return {String | False}
+ */
+@function flint-map-fetch($map, $keys...) {
+	$result: $map;
 
-@function flint-map-fetch($map, $keys) {
-	$has-key: flint-is-map($map) and map-has-key($map, nth($keys, 1)) and map-get($map, nth($keys, 1)) or false;
-	$length: length($keys);
-
-	@if $has-key and $length > 1 {
-		$remainder: ();
-
-		@for $i from 2 through $length {
-			$remainder: append($remainder, nth($keys, $i))
-		}
-
-		@return flint-map-fetch($has-key, $remainder);
+	@each $key in $keys {
+		$result: flint-is-map($result) and map-has-key($result, $key) and map-get($result, $key) or false;
 	}
 
-	@return $has-key;
+	@return $result;
 }

data/stylesheets/flint/functions/lib/_next-index.scss

@@ -1,15 +1,10 @@
-// Returns next indexed key based on passed index
-// -------------------------------------------------------------------------------
-// @param $index [number] : index
-// -------------------------------------------------------------------------------
-// @return [string] | null
-
-@function flint-next-index($index) { 
-	@if $index != (length(flint-map-fetch($flint, "config")) - 1) {
-		@each $key in nth(map-get($flint, "config"), $index + 1) {
-			@return $key;
-		}
-	} @else {
-		@return null;
-	}
+/**
+ * Returns next indexed key based on passed index
+ *
+ * @param {Number} $index - index of breakpoint
+ *
+ * @return {String | False}
+ */
+@function flint-next-index($index) {
+	@return if(flint-is-number($index) and $index != 0, flint-steal-key($index + 1), false);
 }

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

@@ -1,11 +1,12 @@
-// Removes all false and null values from $list
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation.html#purge
-// -------------------------------------------------------------------------------
-// @param $list [list] : list
-// -------------------------------------------------------------------------------
-// @return [list]
-
+/**
+ * Removes all false and null values from $list
+ *
+ * @link http://sassylists.com/documentation.html#purge
+ *
+ * @param {List} $list
+ *
+ * @return {List}
+ */
 @function flint-purge($list) {
 	$result: ();
 

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

@@ -1,13 +1,14 @@
-// Remove $value from $list
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation/#remove
-// -------------------------------------------------------------------------------
-// @param $list [list] : list
-// @param $value [literal] : value to flint-remove
-// @param $recursive [bool] : enable / disable recursivity
-// -------------------------------------------------------------------------------
-// @return [list]
-
+/**
+ * Remove value from list
+ *
+ * @link http://sassylists.com/documentation/#remove
+ *
+ * @param {List} $list
+ * @param {*}    $value
+ * @param {Bool} $recursive
+ *
+ * @return {List}
+ */
 @function flint-remove($list, $value) {
 	@return flint-replace($list, $value, null);
 }

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

@@ -1,11 +1,12 @@
-// Replace substring
-// -------------------------------------------------------------------------------
-// @param $string [string] : string that contains substring
-// @param $substring [string] : substring to replace
-// @param $new-substring [string] : new string to replace sub with
-// -------------------------------------------------------------------------------
-// @return [string]
-
+/**
+ * Replace substring
+ *
+ * @param {String} $string              - string that contains substring
+ * @param {String} $substring           - substring to replace
+ * @param {String} $new-substring (" ") - new string to replace sub with
+ *
+ * @return {String}
+ */
 @function flint-replace-substring($string, $substring, $new-substring: " ") {
 
 	// Use Ruby function if available

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

@@ -1,13 +1,14 @@
-// Replaces $old by $new in $list
-// -------------------------------------------------------------------------------
-// @documentation http://sassylists.com/documentation.html#replace
-// -------------------------------------------------------------------------------
-// @param $list [list] : list
-// @param $old [literal] : value to replace
-// @param $value [literal] : new value for $old
-// -------------------------------------------------------------------------------
-// @return [list]
-
+/**
+ * Replaces old by new in $list
+ *
+ * @link http://sassylists.com/documentation.html#replace
+ *
+ * @param {List} $list
+ * @param {*}    $old
+ * @param {*}    $value
+ *
+ * @return {List}
+ */
 @function flint-replace($list, $old, $value) {
   $running: true;