SassyLists 2.2.2 → 2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01a55bc0fdfbe317688501799cf6f9eb9d139a48
-  data.tar.gz: 9aa64f413e0aadc25d80d190edf36bdf15706549
+  metadata.gz: ef339bb8e66dea3f3e4e17374e9a8f732bd4a20c
+  data.tar.gz: 49a91b0d9d544442da7253098dd3bf4b53209eac
 SHA512:
-  metadata.gz: 17560fb770b3445e0b8539aeea201017f65d12a84bc72c7918e526a9b22f1f7f6946bd35d143c1ed21386fcc486ac4fa82dbc3e53b61fba864061207861d528b
-  data.tar.gz: 9fa42d1731305ef8548d8fc83989923d9b6a1fd9d4b09645fc7c10332b2e28a98756dce1ab0b1e894ed5712a1b24adf9b426338200bd0236715d6e019974c094
+  metadata.gz: 255b789d17661d98be397e23d42fab0dddb7eba4b565de621e5f15fa7edc305e0f0b38af245ecaff2cc2cbfa3456524e1374910e1c12f619bb0e577e232c4361
+  data.tar.gz: a022a8684c913f40b6fe29a8d9c0b1824a50d8580450c953c8dd9ef29dfbc1e78fcaa4cd3fe036ecdea7bf92f6d577ee0b5e42f0dbedf49b3f4d63e724af1c4f

data/CHANGELOG.md

@@ -1,5 +1,6 @@
 # Changelog
 
+* `2.2.3`: adding examples to documentation
 * `2.2.2`: fixing a bug with aliases for `sl-to-list()` and moved all comments to C-like
 * `2.2.1`: improving `sl-to-list()`'s performance
 * `2.2.0`: 

data/lib/SassyLists.rb

@@ -15,7 +15,7 @@ end
 #  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 SassyLists
-  VERSION = "2.2.2"
+  VERSION = "2.2.3"
   DATE = "2014-07-05"
 end
 

data/stylesheets/SassyLists/_chunk.scss

@@ -10,6 +10,10 @@
  *
  * @requires sl-to-list
  *
+ * @example
+ * sl-chunk(a b c d e, 2)
+ * // a b, c d, e
+ *
  * @return {List | Null}
  */
  

data/stylesheets/SassyLists/_comma-list.scss

@@ -3,6 +3,10 @@
  * 
  * @ignore Documentation: http://sassylists.com/documentation.html#sl-comma-list
  *
+ * @example
+ * sl-comma-list()
+ * // ()
+ *
  * @return {List}
  */
 

data/stylesheets/SassyLists/_contain.scss

@@ -6,6 +6,14 @@
  * @param {List}    $list  - list to check
  * @param {*}       $value - value to look for
  *
+ * @example
+ * sl-contain(a b c, a)
+ * // true
+ *
+ * @example
+ * sl-contain(a b c, z)
+ * // false
+ *
  * @return {Bool}
  */
 

data/stylesheets/SassyLists/_count-values.scss

@@ -5,6 +5,10 @@
  *
  * @param {List} $list - list to count values from
  *
+ * @example
+ * sl-count-values(a b c a)
+ * // (a: 2, b: 1, c: 1) 
+ *
  * @return {Map} Values mapped to their count
  */
  

data/stylesheets/SassyLists/_debug.scss

@@ -11,6 +11,10 @@
  * @requires sl-is-single
  * @requires sl-has-multiple-values
  * 
+ * @example
+ * sl-debug(a b c)
+ * // '("a", "b", "c")'
+ *
  * @return {String}
  */
 

data/stylesheets/SassyLists/_every.scss

@@ -7,6 +7,14 @@
  * @param {String}  $function - function to run against every item from list
  * @param {ArgList} $args     - extra arguments to pass to the function
  *
+ * @example
+ * sl-every(1 2 3, unitless)
+ * // true
+ *
+ * @example
+ * sl-every(1 2 3px, unitless)
+ * // false
+ *
  * @return {Bool}
  */
 

data/stylesheets/SassyLists/_explode.scss

@@ -10,6 +10,14 @@
  * @throws $string is not a string for `sl-explode`.
  * @throws $delimiter is not a string for `sl-explode`.
  *
+ * @example
+ * sl-explode(abc)
+ * // a b c
+ *
+ * @example
+ * sl-explode(abc, b)
+ * // a c
+ * 
  * @return {List | Null}
  */
  

data/stylesheets/SassyLists/_first.scss

@@ -7,6 +7,18 @@
  * @throws Cannot find first item of empty list.
  *
  * @requires sl-is-empty
+ *
+ * @example
+ * sl-first(a b c)
+ * // a
+ *
+ * @example
+ * sl-first(a)
+ * // a
+ *
+ * @example
+ * sl-first(())
+ * // null
  * 
  * @return {*}
  */

data/stylesheets/SassyLists/_flatten.scss

@@ -6,7 +6,11 @@
  * @param {List} $list - list to flatten
  * 
  * @requires sl-has-multiple-values
- * 
+ *
+ * @example
+ * sl-flatten(a b c, d e f, g h i)
+ * // a b c d e f g h i
+ *
  * @return {List}
  */
 

data/stylesheets/SassyLists/_has-multiple-values.scss

@@ -5,6 +5,14 @@
  *
  * @param {List} $list - list to run test against
  *
+ * @example 
+ * sl-has-multiple-values(a)
+ * // false
+ *
+ * @example 
+ * sl-has-multiple-values(a b)
+ * // true
+ * 
  * @return {Bool}
  */
  

data/stylesheets/SassyLists/_has-values.scss

@@ -4,6 +4,14 @@
  *
  * @param {List} $list - list to run test against
  *
+ * @example 
+ * sl-has-values(a)
+ * // true
+ *
+ * @example 
+ * sl-has-values(())
+ * // false
+ * 
  * @return {Bool}
  */
  

data/stylesheets/SassyLists/_insert-nth.scss

@@ -11,6 +11,18 @@
  * @throws List index $index is not a number for `sl-insert-nth`.
  * @throws List index $index must be a non-zero integer for `sl-insert-nth`.
  *
+ * @example
+ * sl-insert-nth(a b c, 2, z)
+ * // a z b c
+ *
+ * @example
+ * sl-insert-nth(a b c, 42, z)
+ * // a b c z
+ *
+ * @example 
+ * sl-insert-nth(a b c, -42, z)
+ * // null
+ * 
  * @return {List | Null}
  */
  

data/stylesheets/SassyLists/_intersection.scss

@@ -9,6 +9,10 @@
  * @param {List}    $list  - first list
  * @param {ArgList} $lists - other lists
  *
+ * @example
+ * sl-intersection(a b c, b e d, a c b)
+ * // b
+ * 
  * @return {List}
  */
  

data/stylesheets/SassyLists/_is-empty.scss

@@ -5,6 +5,14 @@
  *
  * @param {List} $list - list to run test against
  *
+ * @example
+ * sl-is-empty(())
+ * // true
+ *
+ * @example
+ * sl-is-empty(a)
+ * // false
+ *
  * @return {Bool}
  */
 

data/stylesheets/SassyLists/_is-single.scss

@@ -5,6 +5,18 @@
  *
  * @param {List} $list - list to run test against
  *
+ * @example
+ * sl-is-single(())
+ * // false
+ *
+ * @example
+ * sl-is-single(a)
+ * // true
+ *
+ * @example
+ * sl-is-single(a b)
+ * // false
+ *
  * @return {Bool}
  */
  

data/stylesheets/SassyLists/_is-symmetrical.scss

@@ -7,6 +7,15 @@
  *
  * @param {List} $list - list to check
  *
+ * @example
+ * sl-is-symmetrical(a b c)
+ * // false
+ *
+ * 
+ * @example
+ * sl-is-symmetrical(a b a)
+ * // true
+ *
  * @return {Bool}
  */
 

data/stylesheets/SassyLists/_last-index.scss

@@ -6,6 +6,14 @@
  * @param {List} $list  - list to search
  * @param {*}    $value - value to be searched for
  *
+ * @example
+ * sl-last-index(a b a, a)
+ * // 3
+ *
+ * @example
+ * sl-last-index(a b a, z)
+ * // null
+ *
  * @return {Number | Null}
  */
  

data/stylesheets/SassyLists/_last.scss

@@ -8,6 +8,18 @@
  * @throws Cannot find last item of empty list.
  *
  * @requires sl-is-empty
+ *
+ * @example
+ * sl-last(a b c)
+ * // c
+ * 
+ * @example
+ * sl-last(a)
+ * // a
+ *
+ * @example
+ * sl-last(())
+ * // null
  * 
  * @return {*}
  */

data/stylesheets/SassyLists/_loop.scss

@@ -11,7 +11,15 @@
  * @throws $value is not a number for `loop`.
  *
  * @requires sl-has-multiple-values
+ *
+ * @example
+ * sl-loop(a b c)
+ * // c a b
  * 
+ * @example
+ * sl-loop(a b c, 2)
+ * // b c a
+ *
  * @return {List | Null}
  */
 

data/stylesheets/SassyLists/_prepend.scss

@@ -9,6 +9,10 @@
  * @param {List} $list  - list to preprend value to
  * @param {*}    $value - value to prepend to the list
  *
+ * @example
+ * sl-prepend(a b c, z)
+ * // z a b c
+ * 
  * @return {List}
  */
  

data/stylesheets/SassyLists/_purge.scss

@@ -7,6 +7,10 @@
  *
  * @param {List} $list - list to purge
  *
+ * @example
+ * sl-purge(null a false b)
+ * // a b
+ *
  * @return {List}
  */
 

data/stylesheets/SassyLists/_random-value.scss

@@ -8,6 +8,10 @@
  * @throws Cannot find a random value in an empty list.
  *
  * @requires sl-is-empty
+ *
+ * @example
+ * sl-random-value(a b c)
+ * // a
  * 
  * @return {*}
  */

data/stylesheets/SassyLists/_range.scss

@@ -9,6 +9,18 @@
  * @throws `$n` is not unitless for `sl-range`.
  * @throws `$n` is not greater than 0 for `sl-range`.
  *
+ * @example
+ * sl-range(5)
+ * // 1 2 3 4 5
+ *
+ * @example
+ * sl-range(1)
+ * // 1
+ *
+ * @example
+ * sl-range(-42)
+ * // null
+ *
  * @return {List | Number | Null}
  */
  

data/stylesheets/SassyLists/_remove-duplicates.scss

@@ -7,6 +7,10 @@
  *
  * @requires sl-to-list
  *
+ * @example
+ * sl-remove-duplicates(a b a b)
+ * // a b
+ *
  * @return {List}
  */
 

data/stylesheets/SassyLists/_remove-nth.scss

@@ -8,6 +8,14 @@
  * @param {List}   $list  - list to remove value from
  * @param {Number} $index - index to remove
  *
+ * @example
+ * sl-remove-nth(a b c, 2)
+ * // a c
+ *
+ * @example
+ * sl-remove-nth(a b c, 42)
+ * // null
+ *
  * @return {List | Null}
  */
 

data/stylesheets/SassyLists/_remove.scss

@@ -9,6 +9,10 @@
  * @param {*}       $value     - value to remove
  * @param {Bool}    $recursive - enable/disable recursion
  *
+ * @example
+ * sl-remove(a b c, a)
+ * // b c
+ *
  * @return {List}
  */
 

data/stylesheets/SassyLists/_replace-nth.scss

@@ -13,6 +13,14 @@
  *
  * @throws Invalid index $index for `sl-replace-nth`.
  *
+ * @example
+ * sl-replace-nth(a b c, 2, z)
+ * // a z c
+ *
+ * @example
+ * sl-replace-nth(a b c, 100, z)
+ * // null
+ *
  * @return {List | Null}
  */
  

data/stylesheets/SassyLists/_replace.scss

@@ -11,6 +11,14 @@
  * @param {*}       $old   - value to replace
  * @param {*}       $value - new value for $old
  *
+ * @example
+ * sl-replace(a b c, b, z)
+ * // a z c
+ *
+ * @example
+ * sl-replace(a b c, y, z)
+ * // a b c
+ * 
  * @return {List}
  */
  

data/stylesheets/SassyLists/_reverse.scss

@@ -7,6 +7,10 @@
  *
  * @requires sl-to-list
  *
+ * @example
+ * sl-reverse(a b c)
+ * // c b a
+ * 
  * @return {List}
  */
 

data/stylesheets/SassyLists/_shuffle.scss

@@ -7,6 +7,10 @@
  *
  * @requires sl-to-list
  * 
+ * @example
+ * sl-shuffle(a b c)
+ * // b a c
+ * 
  * @return {List}
  */
 

data/stylesheets/SassyLists/_slice.scss

@@ -12,7 +12,23 @@
  * @throws List indexes must be non-zero integers for `sl-slice`.
  * @throws Start index has to be lesser than or equal to list length for `sl-slice`.
  * @throws End index has to be lesser than or equal to list length for `sl-slice`.
+ * 
+ * @example
+ * sl-slice(a b c d e, 2, 4)
+ * // b c d
  *
+ * @example
+ * sl-slice(a b c d e, 2, 2)
+ * // b
+ *
+ * @example
+ * sl-slice(a b c d e, 4, 2)
+ * // null
+ *
+ * @example
+ * sl-slice(a b c d e, -1, 6)
+ * // null
+ * 
  * @return {List | Null}
  */
  

data/stylesheets/SassyLists/_some.scss

@@ -7,6 +7,18 @@
  * @param {String}  $function - function to run against every item from list
  * @param {ArgList} $args     - extra arguments to pass to the function
  *
+ * @example
+ * sl-some(1 2 3, unitless)
+ * // true
+ *
+ * @example
+ * sl-some(1 2 3px, unitless)
+ * // true
+ *
+ * @example
+ * sl-some(1px 2px 3px, unitless)
+ * // false
+ *
  * @return {Bool}
  */
  

data/stylesheets/SassyLists/_sort.scss

@@ -10,6 +10,14 @@
  * @param {List} $list  - list to sort
  * @param {List} $order - order to respect
  *
+ * @example
+ * sl-sort(b a c)
+ * // a b c
+ *
+ * @example
+ * sl-sort(3 5 1)
+ * // 1 3 5 
+ *
  * @return {List}
  */
 

data/stylesheets/SassyLists/_sum.scss

@@ -10,6 +10,18 @@
  * @requires sl-is-number
  *
  * @throws All items from list are not numbers for `sl-sum`.
+ *
+ * @example
+ * sl-sum(1 2 3)
+ * // 6
+ *
+ * @example
+ * sl-sum(a b 1)
+ * null
+ *
+ * @example
+ * sl-sum(1 2 3px, true)
+ * // 6
  * 
  * @return {Number}
  */

data/stylesheets/SassyLists/_tail.scss

@@ -7,6 +7,10 @@
  *
  * @param {List} $list - list to retrieve tail from
  *
+ * @example
+ * sl-tail(a b c)
+ * // b c 
+ *
  * @return {List | Null}
  */
  

data/stylesheets/SassyLists/_to-list.scss

@@ -6,6 +6,10 @@
  * @param {*} $value - value to cast to list
  * @param {String} $separator (space) - separator to use
  *
+ * @example
+ * sl-to-list(a b c, comma)
+ * // a, b, c
+ * 
  * @return {List}
  */
 

data/stylesheets/SassyLists/_to-map.scss

@@ -14,6 +14,10 @@
  * @requires sl-is-empty
  * 
  * @throws List cannot be empty for `sl-to-map`.
+ *
+ * @example
+ * sl-to-map(a b c)
+ * // 1 a, 2 b, 3 c
  * 
  * @return {Map | Null}
  */

data/stylesheets/SassyLists/_to-string.scss

@@ -9,6 +9,14 @@
  * @requires sl-has-multiple-values
  * @requires sl-last
  * 
+ * @example
+ * sl-to-string(a b c)
+ * // abc
+ *
+ * @example
+ * sl-to-string(a b c, '-')
+ * // a-b-c
+ * 
  * @return {String}
  */
 

data/stylesheets/SassyLists/_union.scss

@@ -8,6 +8,10 @@
  *
  * @param {ArgList} $lists - lists to unify
  *
+ * @example
+ * sl-union(a b c, b e d, a c b)
+ * // a b c e d
+ * 
  * @return {List}
  */
  

data/stylesheets/SassyLists/_walk.scss

@@ -12,6 +12,10 @@
  * @requires sl-to-map
  * @requires sl-to-list
  *
+ * @example
+ * sl-walk(a b c, to-upper-case)
+ * // A B C
+ *
  * @return {List | Null}
  */
  

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: SassyLists
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.2.3
 platform: ruby
 authors:
 - Hugo Giraudel