Init

Author: pkly

.gitignore

@@ -0,0 +1,2 @@
+/vendor/
+.idea

README.md

@@ -1,2 +1,52 @@
-# phpunit-service-create-trait
+# PHPUnit Service Create Trait
 A helper trait for PHPUnit 10+ for easier creation of services with dependencies in unit testing
+
+## Usage
+
+In any of your PHPUnit test cases simply 
+
+```php
+class MyTestCase extends \PHPUnit\Framework\TestCase {
+    use \Pkly\ServiceMockHelperTrait;
+    
+    private AnyClass $service;
+    
+    public function setUp(): void {
+        $this->service = $this->createRealMockedServiceInstance(AnyClass::class);
+    }
+
+    public function testSomething(): void
+    {
+        $mock = $this->createMock(MyEntity::class);
+    
+        $this->getMockedService(EntityManagerInterface::class)
+            ->expects($this->once())
+            ->method('delete')
+            ->with($mock);
+            
+        $this->service->deleteSomething($mock);
+    }
+}
+```
+
+Any dependencies in the constructor as well as methods marked with Symfony's `#[Required]` attribute will be automatically plugged in with mocks.
+This allows you to write complex tests without wasting time updating your construct calls each time you modify something.
+
+### Okay, but what if I need to use something custom?
+
+Simply assign the proper parameter name in either `$constructor` or `$required` in the appropriate methods.
+That will use your object instead of creating one for you, keep in mind you cannot retrieve it via `$this->getMockedService()`.
+
+### Partial objects?
+
+Sure, works the same, just use `createRealPartialMockedServiceInstance` instead of `createRealMockedServiceInstance`, in that case you must
+also specify the methods to override in your mock. Returned instance is `T&MockObject`.
+
+### Tests? More examples?
+
+I'll add them shortly, for now this code is being used thoroughly in a few of the projects I work at and I grew tired of updating it
+across multiple repositories. It's also very simple, so I doubt anyone is going to complain.
+
+### Feature requests?
+
+Sure, hit me up with an issue if you wish.

composer.json

@@ -0,0 +1,20 @@
+{
+    "name": "pkly/phpunit-service-create-trait",
+    "description": "A helper trait for PHPUnit 10+ for easier creation of services with dependencies in unit testing",
+    "type": "library",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "pkly"
+        }
+    ],
+    "require": {
+        "php": ">=8.2",
+        "phpunit/phpunit": ">=10"
+    },
+    "autoload": {
+        "psr-4": {
+           "Pkly\\": "src/"
+        }
+    }
+}