Documentation update and new feature for <at> relationship

.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.scss]
+indent_style = space
+indent_size = 2

.gitignore

@@ -1,10 +1,14 @@
-.idea
-.sass-cache
-.sassdocrc
-
-node_modules
-sassdoc
+.idea/
+.sass-cache/
+test/.sass-cache/
+node_modules/
+gh-pages/
+coverage/
 
+**/.DS_Store
+.sassdocrc
 /style.scss
 /style.css
 *.map
+
+yarn.lock

README.md

@@ -1,6 +1,6 @@
 # sass-bem
 
-> **Important!** Changed `with` mixin and it will now get siblings with `~` sign. If you want to get first sibling with `+` sign, you can use `next` mixin.
+> **Please upgrade to version 2.6.0**, we have some great features. Thanks to @szalonna and @MartinN3 resolved issue in documentation and updated some mixins.
 
 [![Bower](https://img.shields.io/bower/v/zgabievi/sass-bem.svg?style=flat-square)](http://bower.io/search/?q=sass-bem)
 [![NPM](https://img.shields.io/npm/v/sass-bem.svg?style=flat-square)](https://www.npmjs.com/package/sass-bem)

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "sass-bem",
-  "version": "2.5.3",
+  "version": "2.6.0",
   "main": "_bem.scss",
   "description": "Amazing package for sass to write bem classes, with namespaces and more advanced features.",
   "authors": [

functions/_bem-index.scss

@@ -9,39 +9,32 @@
 /// @returns {Number} - Index of separators
 
 @function bem-index($string) {
-	$e_index: null;
-	$m_index: null;
-
-	//
-	@if (str-index($string, unquote("#{$bem-element-separator}")) != null) {
-		$e_index: str-index($string, unquote("#{$bem-element-separator}"));
-	}
-
-	//
-	@if (str-index($string, unquote("#{$bem-modifier-separator}")) != null) {
-		$m_index: str-index($string, unquote("#{$bem-modifier-separator}"));
-	}
-
-	//
-	@if (str-index($string, ".is") != null) {
-		$m_index: str-index($string, ".is");
-	}
-
-	//
-	@if (str-index($string, ".js") != null) {
-		$m_index: str-index($string, ".js");
-	}
-
-	//
-	@if (str-index($string, ".has") != null) {
-		$m_index: str-index($string, ".has");
-	}
-
-	//
-	@if (str-index($string, ":") != null) {
-		$m_index: str-index($string, ":");
-	}
-
-	//
-	@return math-min($e_index, $m_index, 0);
+  $e_index: null;
+  $m_index: null;
+
+  @if (str-index($string, unquote("#{$bem-element-separator}")) != null) {
+    $e_index: str-index($string, unquote("#{$bem-element-separator}"));
+  }
+
+  @if (str-index($string, unquote("#{$bem-modifier-separator}")) != null) {
+    $m_index: str-index($string, unquote("#{$bem-modifier-separator}"));
+  }
+
+  @if (str-index($string, ".is") != null) {
+    $m_index: str-index($string, ".is");
+  }
+
+  @if (str-index($string, ".js") != null) {
+    $m_index: str-index($string, ".js");
+  }
+
+  @if (str-index($string, ".has") != null) {
+    $m_index: str-index($string, ".has");
+  }
+
+  @if (str-index($string, ":") != null) {
+    $m_index: str-index($string, ":");
+  }
+
+  @return math-min($e_index, $m_index, 0);
 }

functions/_explode.scss

@@ -10,26 +10,23 @@
 /// @returns {List} - List of exploded string
 
 @function explode($string, $separator) {
-	$list: ();
-	$length: str-length($string);
-
-	//
-	@for $i from 1 through $length {
-		$index: str-index($string, $separator);
-
-		//
-		@if str-length($string) >= 1 and $index == null {
-			$list: append($list, $string);
-			$string: '';
-		}
-
-		//
-		@if type-of($index) == number {
-			$each: str-slice($string, 0, ($index - 1));
-			$list: append($list, $each);
-			$string: str-slice($string, ($index + 1), $length);
-		}
-	}
-
-	@return $list;
-}
+  $list: ();
+  $length: str-length($string);
+
+  @for $i from 1 through $length {
+    $index: str-index($string, $separator);
+
+    @if str-length($string) >= 1 and $index == null {
+      $list: append($list, $string);
+      $string: '';
+    }
+
+    @if type-of($index) == number {
+      $each: str-slice($string, 0, ($index - 1));
+      $list: append($list, $each);
+      $string: str-slice($string, ($index + 1), $length);
+    }
+  }
+
+  @return $list;
+}

functions/_get-block.scss

@@ -9,14 +9,11 @@
 /// @returns {String} - Block element
 
 @function get-block($selector) {
-	$block: str-slice($selector, 2, bem-index($selector) - 1);
-
-	//
-	@while (is-block($block) == false) {
-
-		//
-		$block: str-slice($block, 0, bem-index($block) - 1);
-	}
-
-	@return $block;
-}
+  $block: str-slice($selector, 2, bem-index($selector) - 1);
+
+  @while (is-block($block) == false) {
+    $block: str-slice($block, 0, bem-index($block) - 1);
+  }
+
+  @return $block;
+}

functions/_has-pseudo.scss

@@ -9,5 +9,5 @@
 /// @returns {Boolean}
 
 @function has-pseudo($selector) {
-	@return str-index($selector, ":") != null;
-}
+  @return str-index($selector, ":") != null;
+}

functions/_has-state.scss

@@ -9,9 +9,9 @@
 /// @returns {Boolean}
 
 @function has-state($selector) {
-    $separator_is: unquote(".is#{$bem-state-separator}");
-    $separator_js: unquote(".js#{$bem-state-separator}");
-    $separator_has: unquote(".has#{$bem-state-separator}");
-
-	@return str-index($selector, $separator_is) != null or str-index($selector, $separator_js) != null or str-index($selector, $separator_has) != null;
-}
+  $separator_is: unquote(".is#{$bem-state-separator}");
+  $separator_js: unquote(".js#{$bem-state-separator}");
+  $separator_has: unquote(".has#{$bem-state-separator}");
+  
+  @return str-index($selector, $separator_is) != null or str-index($selector, $separator_js) != null or str-index($selector, $separator_has) != null;
+}

functions/_implode.scss

@@ -11,22 +11,17 @@
 /// @returns {String} - Imploded list
 
 @function implode($list, $glue: '', $is-nested: false) {
-	$result: null;
-
-	//
-	@for $i from 1 through length($list) {
-		$e: nth($list, $i);
-
-		//
-		@if type-of($e) == list {
-			$result: unquote("#{$result}#{implode($e, $glue, true)}");
-		}
-
-			//
-		@else {
-			$result: if($i != length($list) or $is-nested, unquote("#{$result}#{$e}#{$glue}"), unquote("#{$result}#{$e}"));
-		}
-	}
-
-	@return $result;
-}
+  $result: null;
+
+  @for $i from 1 through length($list) {
+    $e: nth($list, $i);
+
+    @if type-of($e) == list {
+      $result: unquote("#{$result}#{implode($e, $glue, true)}");
+    } @else {
+      $result: if($i != length($list) or $is-nested, unquote("#{$result}#{$e}#{$glue}"), unquote("#{$result}#{$e}"));
+    }
+  }
+
+  @return $result;
+}

functions/_is-block.scss

@@ -9,5 +9,5 @@
 /// @returns {Boolean}
 
 @function is-block($selector) {
-	@return (not is-element($selector) and not is-modifier($selector) and not has-state($selector) and not has-pseudo($selector));
+  @return not is-element($selector) and not is-modifier($selector) and not has-state($selector) and not has-pseudo($selector);
 }

functions/_is-element.scss

@@ -9,6 +9,7 @@
 /// @returns {Boolean}
 
 @function is-element($selector) {
-    $separator: unquote("#{$bem-element-separator}");
-	@return str-index($selector, $separator) != null;
-}
+  $separator: unquote("#{$bem-element-separator}");
+
+  @return str-index($selector, $separator) != null;
+}

functions/_is-modifier.scss

@@ -9,6 +9,7 @@
 /// @returns {Boolean}
 
 @function is-modifier($selector) {
-    $separator: unquote("#{$bem-modifier-separator}");
-	@return str-index($selector, $separator) != null;
-}
+  $separator: unquote("#{$bem-modifier-separator}");
+
+  @return str-index($selector, $separator) != null;
+}

functions/_math-min.scss

@@ -6,31 +6,26 @@
 ///
 /// @param {String} $a - First number to be checked
 /// @param {String} $n - Second number to be checked
-/// @param {String} $default - Default number to be returned if min wasn't found
+/// @param {String} $default [0] - Default number to be returned if min wasn't found
 ///
 /// @returns {Number} - Minimum number from two of them
 
-@function math-min($a, $b, $default) {
-	$min: $default;
-
-	//
-	@if ($a == null) {
-
-		//
-		@if ($b != null) {
-			$min: $b;
-		}
-	} @else if ($b == null) {
-		$min: $a;
-	} @else {
-
-		//
-		@if ($a <= $b) {
-			$min: $a;
-		} @else {
-			$min: $b;
-		}
-	}
-
-	@return $min;
-}
+@function math-min($a, $b, $default: 0) {
+  $min: $default;
+
+  @if ($a == null) {
+    @if ($b != null) {
+      $min: $b;
+    }
+  } @else if ($b == null) {
+    $min: $a;
+  } @else {
+    @if ($a <= $b) {
+      $min: $a;
+    } @else {
+      $min: $b;
+    }
+  }
+
+  @return $min;
+}

functions/_splice.scss

@@ -11,21 +11,15 @@
 /// @returns {List}
 
 @function splice($list, $value, $recursive: false) {
-	$result: ();
-
-	//
-	@for $i from 1 through length($list) {
-
-		//
-		@if type-of(nth($list, $i)) == list and $recursive {
-			$result: append($result, remove(nth($list, $i), $value, $recursive));
-		}
-
-		//
-		@else if nth($list, $i) != $value {
-			$result: append($result, nth($list, $i));
-		}
-	}
-
-	@return $result;
-}
+  $result: ();
+
+  @for $i from 1 through length($list) {
+    @if type-of(nth($list, $i)) == list and $recursive {
+      $result: append($result, remove(nth($list, $i), $value, $recursive));
+    } @else if nth($list, $i) != $value {
+      $result: append($result, nth($list, $i));
+    }
+  }
+
+  @return $result;
+}

functions/_str-replace.scss

@@ -11,12 +11,11 @@
 /// @returns {String}
 
 @function str-replace($string, $search, $replace: '') {
-	$index: str-index($string, $search);
-
-	//
-	@if $index {
-		@return str-slice($string, 1, $index - 1) + $replace + str-replace(str-slice($string, $index + str-length($search)), $search, $replace);
-	}
-
-	@return $string;
-}
+  $index: str-index($string, $search);
+
+  @if $index {
+    @return str-slice($string, 1, $index - 1) + $replace + str-replace(str-slice($string, $index + str-length($search)), $search, $replace);
+  }
+
+  @return $string;
+}