Merge pull request #118 from nhaarman/improve-argumentcaptor

Add value shortcuts to ArgumentCaptor

Author: nhaarman

mockito-kotlin/src/main/kotlin/com/nhaarman/mockito_kotlin/ArgumentCaptor.kt

@@ -33,21 +33,59 @@ inline fun <reified T : Any> nullableArgumentCaptor(): KArgumentCaptor<T?> = KAr
 
 inline fun <reified T : Any> capture(captor: ArgumentCaptor<T>): T = captor.capture() ?: createInstance<T>()
 
-@Deprecated("Use captor.capture() instead.", ReplaceWith("captor.capture()"), DeprecationLevel.ERROR)
-inline fun <reified T : Any> capture(captor: KArgumentCaptor<T>): T = captor.capture()
-
 class KArgumentCaptor<out T : Any?>(private val captor: ArgumentCaptor<T>, private val tClass: KClass<*>) {
 
+    @Deprecated("Use lastValue", ReplaceWith("lastValue"))
     val value: T
         get() = captor.value
 
+    /**
+     * The first captured value of the argument.
+     * @throws IndexOutOfBoundsException if the value is not available.
+     */
+    val firstValue: T
+        get() = captor.firstValue
+
+    /**
+     * The second captured value of the argument.
+     * @throws IndexOutOfBoundsException if the value is not available.
+     */
+    val secondValue: T
+        get() = captor.secondValue
+
+    /**
+     * The third captured value of the argument.
+     * @throws IndexOutOfBoundsException if the value is not available.
+     */
+    val thirdValue: T
+        get() = captor.thirdValue
+
+    /**
+     * The last captured value of the argument.
+     * @throws IndexOutOfBoundsException if the value is not available.
+     */
+    val lastValue: T
+        get() = captor.lastValue
+
     val allValues: List<T>
         get() = captor.allValues
 
     @Suppress("UNCHECKED_CAST")
     fun capture(): T = captor.capture() ?: createInstance(tClass) as T
 }
 
+val <T> ArgumentCaptor<T>.firstValue: T
+    get() = allValues[0]
+
+val <T> ArgumentCaptor<T>.secondValue: T
+    get() = allValues[1]
+
+val <T> ArgumentCaptor<T>.thirdValue: T
+    get() = allValues[2]
+
+val <T> ArgumentCaptor<T>.lastValue: T
+    get() = allValues.last()
+
 /**
  * This method is deprecated because its behavior differs from the Java behavior.
  * Instead, use [argumentCaptor] in the traditional way, or use one of
@@ -58,3 +96,7 @@ inline fun <reified T : Any> capture(noinline consumer: (T) -> Unit): T {
     var times = 0
     return argThat { if (++times == 1) consumer.invoke(this); true }
 }
+
+@Deprecated("Use captor.capture() instead.", ReplaceWith("captor.capture()"), DeprecationLevel.ERROR)
+inline fun <reified T : Any> capture(captor: KArgumentCaptor<T>): T = captor.capture()
+

mockito-kotlin/src/test/kotlin/ArgumentCaptorTest.kt

@@ -16,7 +16,7 @@ class ArgumentCaptorTest {
         /* Then */
         val captor = argumentCaptor<Long>()
         verify(date).time = captor.capture()
-        expect(captor.value).toBe(5L)
+        expect(captor.lastValue).toBe(5L)
     }
 
     @Test
@@ -30,7 +30,7 @@ class ArgumentCaptorTest {
         /* Then */
         val captor = argumentCaptor<String>()
         verify(m).nullableString(captor.capture())
-        expect(captor.value).toBeNull()
+        expect(captor.lastValue).toBeNull()
     }
 
     @Test
@@ -44,7 +44,7 @@ class ArgumentCaptorTest {
         /* Then */
         val captor = nullableArgumentCaptor<String>()
         verify(m).nullableString(captor.capture())
-        expect(captor.value).toBeNull()
+        expect(captor.lastValue).toBeNull()
     }
 
     @Test
@@ -76,4 +76,43 @@ class ArgumentCaptorTest {
         verify(m, times(2)).nullableString(captor.capture())
         expect(captor.allValues).toBe(listOf("test", null))
     }
-}
+
+    @Test
+    fun argumentCaptor_callProperties() {
+        /* Given */
+        val m: Methods = mock()
+
+        /* When */
+        m.int(1)
+        m.int(2)
+        m.int(3)
+        m.int(4)
+        m.int(5)
+
+        /* Then */
+        argumentCaptor<Int>().apply {
+            verify(m, times(5)).int(capture())
+
+            expect(firstValue).toBe(1)
+            expect(secondValue).toBe(2)
+            expect(thirdValue).toBe(3)
+            expect(lastValue).toBe(5)
+        }
+    }
+
+    @Test(expected = IndexOutOfBoundsException::class)
+    fun argumentCaptor_callPropertyNotAvailable() {
+        /* Given */
+        val m: Methods = mock()
+
+        /* When */
+        m.int(1)
+
+        /* Then */
+        argumentCaptor<Int>().apply {
+            verify(m).int(capture())
+
+            expect(secondValue).toBe(2)
+        }
+    }
+}

mockito-kotlin/src/test/kotlin/Classes.kt

@@ -49,6 +49,7 @@ interface Methods {
     fun closedStringMap(m: Map<Closed, String>)
     fun closedSet(s: Set<Closed>)
     fun string(s: String)
+    fun int(i: Int)
     fun closedVararg(vararg c: Closed)
     fun throwableClass(t: ThrowableClass)
     fun nullableString(s: String?)

mockito-kotlin/src/test/kotlin/CreateInstanceTest.kt

@@ -525,12 +525,12 @@ class CreateInstanceTest {
             throw AssertionError("Forbidden.")
         }
 
-        constructor(value: Int) {
+        constructor(@Suppress("UNUSED_PARAMETER") value: Int) {
         }
     }
 
     class WithDefaultEmptyConstructor() {
-        constructor(c: ForbiddenConstructor) : this()
+        constructor(@Suppress("UNUSED_PARAMETER") c: ForbiddenConstructor) : this()
     }
 
     /**
@@ -549,7 +549,7 @@ class CreateInstanceTest {
      */
     class WithDefaultParameters constructor(val first: Int = 1, val second: Int = 2) {
 
-        constructor(first: Int) : this() {
+        constructor(@Suppress("UNUSED_PARAMETER") first: Int) : this() {
             error("Should not be called")
         }
     }

mockito-kotlin/src/testInlineMockito/kotlin/CreateInstanceInlineTest.kt

@@ -33,7 +33,7 @@ class CreateInstanceInlineTest {
 
     class ClassToBeMocked {
 
-        fun doSomething(c: ClassToBeMocked) {
+        fun doSomething(@Suppress("UNUSED_PARAMETER") c: ClassToBeMocked) {
         }
 
         fun doSomethingElse(value: BigInteger): BigInteger {