From b3b3a9fcefd0b4c1e32e360aeed9fb2376a6e7d2 Mon Sep 17 00:00:00 2001
From: Mike Gerwitz <mike@mikegerwitz.com>
Date: Sat, 10 May 2014 00:34:01 -0400
Subject: [PATCH] Added shift argument to expectation handlers

This allows the implementation to vary in the number of arguments provided
to the expectation handlers without breaking BC so long as the meanings of
the shifted arguments do not change.
---
 src/spec       |  7 ++++-
 test/test-spec | 80 ++++++++++++++++++++++++++++++++++++++------------
 2 files changed, 67 insertions(+), 20 deletions(-)

diff --git a/src/spec b/src/spec
index 50a63f8..7c8ef09 100644
--- a/src/spec
+++ b/src/spec
@@ -167,7 +167,12 @@ to()
   type "$assert" &>/dev/null \
     || _bail "unknown expectation: \`$type'" $__spec_caller
 
-  $assert "$__spec_rexit" "$@" <<< "$__spec_result" \
+  # first argument is exit code, second is the number of arguments to shift
+  # to place $1 at the remainder clause, and all remaining arguments are
+  # said remainder clause; the shift argument allows the implementation to
+  # vary without breaking BC so long as the meaning of the shifted arguments
+  # do not change
+  $assert "$__spec_rexit" 2 "$@" <<< "$__spec_result" \
     || fail "$expect_full"
 
   __spec_caller=
diff --git a/test/test-spec b/test/test-spec
index b576e55..a25525a 100644
--- a/test/test-spec
+++ b/test/test-spec
@@ -127,30 +127,72 @@ describe expect
     '; to fail
   end
 
-  it properly executes quoted command lines
-    expect test-run <<< '
-      chk() { test $# -eq 1; }
-      describe foo
-        it handles whitespace
-          expect chk "foo bar"
-            to succeed
+
+  # the "premise" is the command executed by the `expect' line
+  describe premise
+    it properly executes quoted command lines
+      expect test-run <<< '
+        chk() { test $# -eq 1; }
+        describe foo
+          it handles whitespace
+            expect chk "foo bar"
+              to succeed
+          end
         end
-      end
-    '; to succeed
+      '; to succeed
+    end
   end
 
-  it pipes command stdout to expectation handler
-    expect test-run <<< '
-      declare str=foo
-      _expect--chk() { test "$(cat)" == "$2"; }
 
-      describe foo
-        it pipes command output
-          expect echo "$str"
-            to chk "$str"
+  # the expectation handler performs the assertion logic
+  describe handler
+    it is provided premise exit code as first argument
+      expect test-run <<< '
+        declare excode=123
+        _expect--chk() { test "$1" -eq $excode; }
+
+        describe foo
+          it exposes exit code
+            expect exit $excode
+              to chk
+          end
         end
-      end
-    '; to succeed
+      '; to succeed
+    end
+
+    # the "remainder" clause is the portion of the sentence that follows the
+    # execution of the expectation handler
+    it is provided remainder clause after shift argument
+      expect test-run <<< '
+        declare remain="a b c"
+        _expect--chk()
+        {
+          shift "$2"
+          test "$*" == "$remain"
+        }
+
+        describe foo
+          it should expose remainder clause
+            expect true
+              to chk $remain
+          end
+        end
+      '; to succeed
+    end
+
+    it receives premise output via stdin
+      expect test-run <<< '
+        declare str=foo
+        _expect--chk() { test "$(cat)" == "$str"; }
+
+        describe foo
+          it pipes command output
+            expect echo "$str"
+              to chk
+          end
+        end
+      '; to succeed
+    end
   end