Extract method() from template into trait

sebastianbergmann · Jun 28, 2019 · 5496e01 · 5496e01
1 parent 6377eae
commit 5496e01
Show file tree

Hide file tree

Showing 49 changed files with 76 additions and 371 deletions.
diff --git a/src/Framework/MockObject/Generator.php b/src/Framework/MockObject/Generator.php
@@ -831,7 +831,7 @@ private function generateMock($type, ?array $explicitMethods, string $mockClassN
         $method = '';
 
         if (!$mockMethods->hasMethod('method') && (!isset($class) || !$class->hasMethod('method'))) {
-            $method = $this->getTemplate('mocked_class_method.tpl')->render();
+            $method = \PHP_EOL . '    use \PHPUnit\Framework\MockObject\TestDoubleApiMethod;';
         }
 
         $classTemplate->setVar(

diff --git a/src/Framework/MockObject/Generator/mocked_class.tpl.dist b/src/Framework/MockObject/Generator/mocked_class.tpl.dist
@@ -2,6 +2,6 @@ declare(strict_types=1);
 
 {prologue}{class_declaration}
 {
-    use \PHPUnit\Framework\MockObject\TestDoubleApi;
+    use \PHPUnit\Framework\MockObject\TestDoubleApi;{method}
 
-{clone}{mocked_methods}{method}}{epilogue}
+{clone}{mocked_methods}}{epilogue}
diff --git a/src/Framework/MockObject/Generator/mocked_class_method.tpl.dist b/src/Framework/MockObject/Generator/mocked_class_method.tpl.dist
diff --git a/src/Framework/MockObject/TestDoubleApiMethod.php b/src/Framework/MockObject/TestDoubleApiMethod.php
@@ -0,0 +1,28 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\Framework\MockObject;
+
+use PHPUnit\Framework\MockObject\Matcher\AnyInvokedCount;
+
+/**
+ * @internal This trait is not covered by the backward compatibility promise for PHPUnit
+ */
+trait TestDoubleApiMethod
+{
+    public function method()
+    {
+        $expects = $this->expects(new AnyInvokedCount);
+
+        return \call_user_func_array(
+            [$expects, 'method'],
+            \func_get_args()
+        );
+    }
+}
diff --git a/tests/end-to-end/mock-objects/generator/232.phpt b/tests/end-to-end/mock-objects/generator/232.phpt
@@ -57,6 +57,7 @@ declare(strict_types=1);
 class MockFoo extends Foo implements PHPUnit\Framework\MockObject\MockObject
 {
     use \PHPUnit\Framework\MockObject\TestDoubleApi;
+    use \PHPUnit\Framework\MockObject\TestDoubleApiMethod;
 
     public function __clone()
     {
@@ -84,12 +85,4 @@ class MockFoo extends Foo implements PHPUnit\Framework\MockObject\MockObject
 
         return $__phpunit_result;
     }
-
-    public function method()
-    {
-        $any     = new \PHPUnit\Framework\MockObject\Matcher\AnyInvokedCount;
-        $expects = $this->expects($any);
-
-        return call_user_func_array([$expects, 'method'], func_get_args());
-    }
 }
diff --git a/tests/end-to-end/mock-objects/generator/3154_namespaced_constant_resolving.phpt b/tests/end-to-end/mock-objects/generator/3154_namespaced_constant_resolving.phpt
@@ -42,6 +42,7 @@ declare(strict_types=1);
 class Issue3154Mock extends Is\Namespaced\Issue3154 implements PHPUnit\Framework\MockObject\MockObject
 {
     use \PHPUnit\Framework\MockObject\TestDoubleApi;
+    use \PHPUnit\Framework\MockObject\TestDoubleApiMethod;
 
     public function __clone()
     {
@@ -69,12 +70,4 @@ class Issue3154Mock extends Is\Namespaced\Issue3154 implements PHPUnit\Framework
 
         return $__phpunit_result;
     }
-
-    public function method()
-    {
-        $any     = new \PHPUnit\Framework\MockObject\Matcher\AnyInvokedCount;
-        $expects = $this->expects($any);
-
-        return call_user_func_array([$expects, 'method'], func_get_args());
-    }
 }
diff --git a/tests/end-to-end/mock-objects/generator/397.phpt b/tests/end-to-end/mock-objects/generator/397.phpt
@@ -28,6 +28,7 @@ declare(strict_types=1);
 class MockC extends C implements PHPUnit\Framework\MockObject\MockObject
 {
     use \PHPUnit\Framework\MockObject\TestDoubleApi;
+    use \PHPUnit\Framework\MockObject\TestDoubleApiMethod;
 
     public function __clone()
     {
@@ -55,12 +56,4 @@ class MockC extends C implements PHPUnit\Framework\MockObject\MockObject
 
         return $__phpunit_result;
     }
-
-    public function method()
-    {
-        $any     = new \PHPUnit\Framework\MockObject\Matcher\AnyInvokedCount;
-        $expects = $this->expects($any);
-
-        return call_user_func_array([$expects, 'method'], func_get_args());
-    }
 }
diff --git a/tests/end-to-end/mock-objects/generator/abstract_class.phpt b/tests/end-to-end/mock-objects/generator/abstract_class.phpt
@@ -32,6 +32,7 @@ declare(strict_types=1);
 class MockFoo extends Foo implements PHPUnit\Framework\MockObject\MockObject
 {
     use \PHPUnit\Framework\MockObject\TestDoubleApi;
+    use \PHPUnit\Framework\MockObject\TestDoubleApiMethod;
 
     public function __clone()
     {
@@ -103,12 +104,4 @@ class MockFoo extends Foo implements PHPUnit\Framework\MockObject\MockObject
 
         return $__phpunit_result;
     }
-
-    public function method()
-    {
-        $any     = new \PHPUnit\Framework\MockObject\Matcher\AnyInvokedCount;
-        $expects = $this->expects($any);
-
-        return call_user_func_array([$expects, 'method'], func_get_args());
-    }
 }
diff --git a/tests/end-to-end/mock-objects/generator/class.phpt b/tests/end-to-end/mock-objects/generator/class.phpt
@@ -32,6 +32,7 @@ declare(strict_types=1);
 class MockFoo extends Foo implements PHPUnit\Framework\MockObject\MockObject
 {
     use \PHPUnit\Framework\MockObject\TestDoubleApi;
+    use \PHPUnit\Framework\MockObject\TestDoubleApiMethod;
 
     public function __clone()
     {
@@ -81,12 +82,4 @@ class MockFoo extends Foo implements PHPUnit\Framework\MockObject\MockObject
 
         return $__phpunit_result;
     }
-
-    public function method()
-    {
-        $any     = new \PHPUnit\Framework\MockObject\Matcher\AnyInvokedCount;
-        $expects = $this->expects($any);
-
-        return call_user_func_array([$expects, 'method'], func_get_args());
-    }
 }
diff --git a/tests/end-to-end/mock-objects/generator/class_call_parent_clone.phpt b/tests/end-to-end/mock-objects/generator/class_call_parent_clone.phpt
@@ -27,18 +27,11 @@ declare(strict_types=1);
 class MockFoo extends Foo implements PHPUnit\Framework\MockObject\MockObject
 {
     use \PHPUnit\Framework\MockObject\TestDoubleApi;
+    use \PHPUnit\Framework\MockObject\TestDoubleApiMethod;
 
     public function __clone()
     {
         $this->__phpunit_invocationMocker = clone $this->__phpunit_getInvocationMocker();
         parent::__clone();
     }
-
-    public function method()
-    {
-        $any     = new \PHPUnit\Framework\MockObject\Matcher\AnyInvokedCount;
-        $expects = $this->expects($any);
-
-        return call_user_func_array([$expects, 'method'], func_get_args());
-    }
 }
diff --git a/tests/end-to-end/mock-objects/generator/class_call_parent_constructor.phpt b/tests/end-to-end/mock-objects/generator/class_call_parent_constructor.phpt
@@ -27,17 +27,10 @@ declare(strict_types=1);
 class MockFoo extends Foo implements PHPUnit\Framework\MockObject\MockObject
 {
     use \PHPUnit\Framework\MockObject\TestDoubleApi;
+    use \PHPUnit\Framework\MockObject\TestDoubleApiMethod;
 
     public function __clone()
     {
         $this->__phpunit_invocationMocker = clone $this->__phpunit_getInvocationMocker();
     }
-
-    public function method()
-    {
-        $any     = new \PHPUnit\Framework\MockObject\Matcher\AnyInvokedCount;
-        $expects = $this->expects($any);
-
-        return call_user_func_array([$expects, 'method'], func_get_args());
-    }
 }
diff --git a/tests/end-to-end/mock-objects/generator/class_dont_call_parent_clone.phpt b/tests/end-to-end/mock-objects/generator/class_dont_call_parent_clone.phpt
@@ -27,17 +27,10 @@ declare(strict_types=1);
 class MockFoo extends Foo implements PHPUnit\Framework\MockObject\MockObject
 {
     use \PHPUnit\Framework\MockObject\TestDoubleApi;
+    use \PHPUnit\Framework\MockObject\TestDoubleApiMethod;
 
     public function __clone()
     {
         $this->__phpunit_invocationMocker = clone $this->__phpunit_getInvocationMocker();
     }
-
-    public function method()
-    {
-        $any     = new \PHPUnit\Framework\MockObject\Matcher\AnyInvokedCount;
-        $expects = $this->expects($any);
-
-        return call_user_func_array([$expects, 'method'], func_get_args());
-    }
 }
diff --git a/tests/end-to-end/mock-objects/generator/class_dont_call_parent_constructor.phpt b/tests/end-to-end/mock-objects/generator/class_dont_call_parent_constructor.phpt
@@ -27,17 +27,10 @@ declare(strict_types=1);
 class MockFoo extends Foo implements PHPUnit\Framework\MockObject\MockObject
 {
     use \PHPUnit\Framework\MockObject\TestDoubleApi;
+    use \PHPUnit\Framework\MockObject\TestDoubleApiMethod;
 
     public function __clone()
     {
         $this->__phpunit_invocationMocker = clone $this->__phpunit_getInvocationMocker();
     }
-
-    public function method()
-    {
-        $any     = new \PHPUnit\Framework\MockObject\Matcher\AnyInvokedCount;
-        $expects = $this->expects($any);
-
-        return call_user_func_array([$expects, 'method'], func_get_args());
-    }
 }
diff --git a/...d-to-end/mock-objects/generator/class_implementing_interface_call_parent_constructor.phpt b/...d-to-end/mock-objects/generator/class_implementing_interface_call_parent_constructor.phpt
@@ -32,17 +32,10 @@ declare(strict_types=1);
 class MockFoo extends Foo implements PHPUnit\Framework\MockObject\MockObject
 {
     use \PHPUnit\Framework\MockObject\TestDoubleApi;
+    use \PHPUnit\Framework\MockObject\TestDoubleApiMethod;
 
     public function __clone()
     {
         $this->__phpunit_invocationMocker = clone $this->__phpunit_getInvocationMocker();
     }
-
-    public function method()
-    {
-        $any     = new \PHPUnit\Framework\MockObject\Matcher\AnyInvokedCount;
-        $expects = $this->expects($any);
-
-        return call_user_func_array([$expects, 'method'], func_get_args());
-    }
 }
diff --git a/...end/mock-objects/generator/class_implementing_interface_dont_call_parent_constructor.phpt b/...end/mock-objects/generator/class_implementing_interface_dont_call_parent_constructor.phpt
@@ -32,17 +32,10 @@ declare(strict_types=1);
 class MockFoo extends Foo implements PHPUnit\Framework\MockObject\MockObject
 {
     use \PHPUnit\Framework\MockObject\TestDoubleApi;
+    use \PHPUnit\Framework\MockObject\TestDoubleApiMethod;
 
     public function __clone()
     {
         $this->__phpunit_invocationMocker = clone $this->__phpunit_getInvocationMocker();
     }
-
-    public function method()
-    {
-        $any     = new \PHPUnit\Framework\MockObject\Matcher\AnyInvokedCount;
-        $expects = $this->expects($any);
-
-        return call_user_func_array([$expects, 'method'], func_get_args());
-    }
 }
diff --git a/tests/end-to-end/mock-objects/generator/class_nonexistent_method.phpt b/tests/end-to-end/mock-objects/generator/class_nonexistent_method.phpt
@@ -28,6 +28,7 @@ declare(strict_types=1);
 class MockFoo extends Foo implements PHPUnit\Framework\MockObject\MockObject
 {
     use \PHPUnit\Framework\MockObject\TestDoubleApi;
+    use \PHPUnit\Framework\MockObject\TestDoubleApiMethod;
 
     public function __clone()
     {
@@ -55,12 +56,4 @@ class MockFoo extends Foo implements PHPUnit\Framework\MockObject\MockObject
 
         return $__phpunit_result;
     }
-
-    public function method()
-    {
-        $any     = new \PHPUnit\Framework\MockObject\Matcher\AnyInvokedCount;
-        $expects = $this->expects($any);
-
-        return call_user_func_array([$expects, 'method'], func_get_args());
-    }
 }
diff --git a/tests/end-to-end/mock-objects/generator/class_partial.phpt b/tests/end-to-end/mock-objects/generator/class_partial.phpt
@@ -32,6 +32,7 @@ declare(strict_types=1);
 class MockFoo extends Foo implements PHPUnit\Framework\MockObject\MockObject
 {
     use \PHPUnit\Framework\MockObject\TestDoubleApi;
+    use \PHPUnit\Framework\MockObject\TestDoubleApiMethod;
 
     public function __clone()
     {
@@ -59,12 +60,4 @@ class MockFoo extends Foo implements PHPUnit\Framework\MockObject\MockObject
 
         return $__phpunit_result;
     }
-
-    public function method()
-    {
-        $any     = new \PHPUnit\Framework\MockObject\Matcher\AnyInvokedCount;
-        $expects = $this->expects($any);
-
-        return call_user_func_array([$expects, 'method'], func_get_args());
-    }
 }
diff --git a/tests/end-to-end/mock-objects/generator/class_with_deprecated_method.phpt b/tests/end-to-end/mock-objects/generator/class_with_deprecated_method.phpt
@@ -32,6 +32,7 @@ declare(strict_types=1);
 class MockFoo extends ClassWithDeprecatedMethod implements PHPUnit\Framework\MockObject\MockObject
 {
     use \PHPUnit\Framework\MockObject\TestDoubleApi;
+    use \PHPUnit\Framework\MockObject\TestDoubleApiMethod;
 
     public function __clone()
     {
@@ -61,12 +62,4 @@ class MockFoo extends ClassWithDeprecatedMethod implements PHPUnit\Framework\Moc
 
         return $__phpunit_result;
     }
-
-    public function method()
-    {
-        $any     = new \PHPUnit\Framework\MockObject\Matcher\AnyInvokedCount;
-        $expects = $this->expects($any);
-
-        return call_user_func_array([$expects, 'method'], func_get_args());
-    }
 }
diff --git a/tests/end-to-end/mock-objects/generator/class_with_final_method.phpt b/tests/end-to-end/mock-objects/generator/class_with_final_method.phpt
@@ -28,17 +28,10 @@ declare(strict_types=1);
 class MockFoo extends ClassWithFinalMethod implements PHPUnit\Framework\MockObject\MockObject
 {
     use \PHPUnit\Framework\MockObject\TestDoubleApi;
+    use \PHPUnit\Framework\MockObject\TestDoubleApiMethod;
 
     public function __clone()
     {
         $this->__phpunit_invocationMocker = clone $this->__phpunit_getInvocationMocker();
     }
-
-    public function method()
-    {
-        $any     = new \PHPUnit\Framework\MockObject\Matcher\AnyInvokedCount;
-        $expects = $this->expects($any);
-
-        return call_user_func_array([$expects, 'method'], func_get_args());
-    }
 }
diff --git a/...mock-objects/generator/class_with_method_with_nullable_typehinted_variadic_arguments.phpt b/...mock-objects/generator/class_with_method_with_nullable_typehinted_variadic_arguments.phpt
@@ -28,6 +28,7 @@ declare(strict_types=1);
 class MockFoo extends ClassWithMethodWithNullableTypehintedVariadicArguments implements PHPUnit\Framework\MockObject\MockObject
 {
     use \PHPUnit\Framework\MockObject\TestDoubleApi;
+    use \PHPUnit\Framework\MockObject\TestDoubleApiMethod;
 
     public function __clone()
     {
@@ -55,12 +56,4 @@ class MockFoo extends ClassWithMethodWithNullableTypehintedVariadicArguments imp
 
         return $__phpunit_result;
     }
-
-    public function method()
-    {
-        $any     = new \PHPUnit\Framework\MockObject\Matcher\AnyInvokedCount;
-        $expects = $this->expects($any);
-
-        return call_user_func_array([$expects, 'method'], func_get_args());
-    }
 }
diff --git a/...d-to-end/mock-objects/generator/class_with_method_with_typehinted_variadic_arguments.phpt b/...d-to-end/mock-objects/generator/class_with_method_with_typehinted_variadic_arguments.phpt
@@ -28,6 +28,7 @@ declare(strict_types=1);
 class MockFoo extends ClassWithMethodWithTypehintedVariadicArguments implements PHPUnit\Framework\MockObject\MockObject
 {
     use \PHPUnit\Framework\MockObject\TestDoubleApi;
+    use \PHPUnit\Framework\MockObject\TestDoubleApiMethod;
 
     public function __clone()
     {
@@ -55,12 +56,4 @@ class MockFoo extends ClassWithMethodWithTypehintedVariadicArguments implements
 
         return $__phpunit_result;
     }
-
-    public function method()
-    {
-        $any     = new \PHPUnit\Framework\MockObject\Matcher\AnyInvokedCount;
-        $expects = $this->expects($any);
-
-        return call_user_func_array([$expects, 'method'], func_get_args());
-    }
 }