Add the &any-order flag to should-emit (#19)

Author: giancosta86

README.md

@@ -177,7 +177,7 @@ In the default console reporter, the **test output** - on both _stdout_ and _std
 
   The input mechanism and the equality logic are the same as those described for `should-be`.
 
-- `should-emit`: ensures that the values passed via pipe (`|`) are _exactly the values_ in the `expected` list; _emission order matters_, unless the `order-key` option is set; on the other hand, the `strict` option works according to the equality rules described within the context of `should-be`.
+- `should-emit`: ensures that the values passed via pipe (`|`) are _exactly the values_ in the `expected` list; _emission order matters_, unless the `order-key` option or its mutally-exclusive `any-order` counterpart flag is set; on the other hand, the `strict` option works according to the equality rules described within the context of `should-be`.
 
   The overall command is equivalent to:
 
@@ -209,6 +209,19 @@ In the default console reporter, the **test output** - on both _stdout_ and _std
       Hello
       World
     ]
+
+  all [
+    92
+    90
+    (num 98)
+    95
+  ] |
+    should-emit &any-order [
+      90
+      92
+      95
+      98
+    ]
   ```
 
   **Please, note**: in lieu of a `should-emit` with just one value, it's more expressive to use `should-be`.

assertions/shared.elv

@@ -105,4 +105,18 @@ fn create-assertion-on-tested-entries { |test description fail-message|
       fail $fail-message
     }
   }
+}
+
+fn equalize { |&strict=$false &order-key=$nil|
+  all | each { |value|
+    get-minimal &strict=$strict $value
+  } |
+    {
+      if $order-key {
+        all |
+          order &key=$order-key
+      } else {
+        all
+      }
+    }
 }

assertions/shared.test.elv

@@ -65,4 +65,61 @@ use ./shared
         ]
     }
   }
+
+  >> 'getting an equalized list' {
+    var source = [
+      (num 95)
+      90
+      98
+      (num 92)
+    ]
+
+    >> 'when the strict flag is disabled' {
+      >> 'when the order key is missing' {
+        all $source |
+          shared:equalize |
+          should-emit &strict [
+            95
+            90
+            98
+            92
+          ]
+      }
+
+      >> 'when the order key is passed' {
+        all $source |
+          shared:equalize &order-key=$to-string~ |
+          should-emit &strict [
+            90
+            92
+            95
+            98
+          ]
+      }
+    }
+
+    >> 'when the strict flag is enabled' {
+      >> 'when the order key is missing' {
+        all $source |
+          shared:equalize &strict |
+          should-emit &strict [
+            (num 95)
+            90
+            98
+            (num 92)
+          ]
+      }
+
+      >> 'when the order key is passed' {
+        all $source |
+          shared:equalize &strict &order-key=$to-string~ |
+          should-emit &strict [
+            90
+            (num 92)
+            (num 95)
+            98
+          ]
+      }
+    }
+  }
 }

assertions/should-emit.elv

@@ -2,24 +2,28 @@ use ./shared
 
 var -error-message-base = 'should-emit assertion failed'
 
-fn should-emit { |&strict=$false &order-key=$nil expected|
+fn should-emit { |&strict=$false &order-key=$nil &any-order=$false expected|
   if (not-eq (kind-of $expected) list) {
     fail 'The expected argument must be a list of values'
   }
 
-  var actual = (
+  if $any-order {
     if $order-key {
-      put [(
-        all |
-          order &key=$order-key
-      )]
+      fail 'The &any-order flag and the &order-key option are mutually exclusive!'
     } else {
-      put [(all)]
-    } |
-      shared:get-minimal &strict=$strict
-  )
+      set order-key = $to-string~
+    }
+  }
+
+  var actual = [(
+    all |
+      shared:equalize &strict=$strict &order-key=$order-key
+  )]
 
-  var expected = (shared:get-minimal &strict=$strict $expected)
+  var expected = [(
+    all $expected |
+      shared:equalize &strict=$strict &order-key=$order-key
+  )]
 
   if (not-eq $actual $expected) {
     shared:contrast [

assertions/should-emit.test.elv

@@ -124,6 +124,34 @@ var expect-failure~ = (shared:create-expect-failure $should-emit~ $should-emit:-
       ]
   }
 
+  >> 'when any order is admitted' {
+    >> 'when the actual items and the expected items are the same, but in different order' {
+      all [
+        92
+        90
+        (num 98)
+        95
+      ] |
+        should-emit &any-order [
+          90
+          92
+          95
+          98
+        ]
+    }
+
+    >> 'when passing an order-key, too' {
+      fails {
+        all [
+          90
+          92
+        ] |
+          should-emit &order-key=$num~ &any-order [ 92 90 ]
+      } |
+        should-be 'The &any-order flag and the &order-key option are mutually exclusive!'
+    }
+  }
+
   >> 'when failing' {
     >> 'the output should describe the context' {
       var output-tester = (