Merge pull request #22 from dotkernel/issue-21

Issue #21: Implemented Codecov

Author: alexmerlin

.github/workflows/codecov.yml

@@ -0,0 +1,53 @@
+on:
+  - push
+
+name: Run Codecov checks
+
+jobs:
+  code-coverage:
+    name: Code Coverage
+
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+
+        php:
+          - "8.1"
+          - "8.2"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "${{ matrix.php }}"
+          coverage: pcov
+          ini-values: assert.exception=1, zend.assertions=1, error_reporting=-1, log_errors_max_len=0, display_errors=On
+          tools: composer:v2, cs2pr
+
+      - name: Determine composer cache directory
+        run: echo "COMPOSER_CACHE_DIR=$(composer config cache-dir)" >> $GITHUB_ENV
+
+      - name: Cache dependencies installed with composer
+        uses: actions/cache@v3
+        with:
+          path: ${{ env.COMPOSER_CACHE_DIR }}
+          key: php${{ matrix.php }}-composer-${{ hashFiles('**/composer.json') }}
+          restore-keys: |
+            php${{ matrix.php }}-composer-
+
+      - name: Install dependencies with composer
+        run: composer install --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
+
+      - name: Collect code coverage with PHPUnit
+        run: vendor/bin/phpunit --colors=always --coverage-clover clover.xml
+
+      - name: Send code coverage report to Codecov.io
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/cs-tests.yml

@@ -40,7 +40,7 @@ jobs:
           restore-keys: |
             php${{ matrix.php }}-composer-
       - name: Install dependencies with composer
-        run: composer update --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
+        run: composer install --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
 
       - name: Run phpcs checks
         run: vendor/bin/phpcs

.github/workflows/static-analysis.yml

@@ -40,7 +40,7 @@ jobs:
           restore-keys: |
             php${{ matrix.php }}-composer-
       - name: Install dependencies with composer
-        run: composer update --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
+        run: composer install --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
 
       - name: Run static analysis
         run: vendor/bin/psalm --no-cache --output-format=github --show-info=false --threads=4

README.md

@@ -5,24 +5,25 @@ DotKernel component used to create services through [Laminas Service Manager](ht
 This package can clean up your code, by getting rid of all the factories you write, sometimes just to inject a dependency or two.
 
 ![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/dot-annotated-services)
-![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-annotated-services/4.1.0)
+![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-annotated-services/4.1.3)
 
 [![GitHub issues](https://img.shields.io/github/issues/dotkernel/dot-annotated-services)](https://github.com/dotkernel/dot-annotated-services/issues)
 [![GitHub forks](https://img.shields.io/github/forks/dotkernel/dot-annotated-services)](https://github.com/dotkernel/dot-annotated-services/network)
 [![GitHub stars](https://img.shields.io/github/stars/dotkernel/dot-annotated-services)](https://github.com/dotkernel/dot-annotated-services/stargazers)
 [![GitHub license](https://img.shields.io/github/license/dotkernel/dot-annotated-services)](https://github.com/dotkernel/dot-annotated-services/blob/4.0/LICENSE.md)
 
 [![Build Static](https://github.com/dotkernel/dot-annotated-services/actions/workflows/static-analysis.yml/badge.svg?branch=4.0)](https://github.com/dotkernel/dot-annotated-services/actions/workflows/static-analysis.yml)
+[![codecov](https://codecov.io/gh/dotkernel/dot-annotated-services/graph/badge.svg?token=ZBZDEA3LY8)](https://codecov.io/gh/dotkernel/dot-annotated-services)
 
 [![SymfonyInsight](https://insight.symfony.com/projects/a0d7016e-fc3f-46b8-9b36-571ff060d744/big.svg)](https://insight.symfony.com/projects/a0d7016e-fc3f-46b8-9b36-571ff060d744)
 
 
 ## Installation
 
 Run the following command in your project directory
-```bash
-$ composer require dotkernel/dot-annotated-services
-```
+
+    composer require dotkernel/dot-annotated-services
+
 
 After installing, add the `ConfigProvider` class to your configuration aggregate.
 
@@ -43,28 +44,30 @@ return [
 
 The next step is to annotate the service constructor or setters with the service names to inject
 ```php
-use Dot\AnnotatedServices\Annotation\Service;
 use Dot\AnnotatedServices\Annotation\Inject;
 
 /**
- * Service constructor
- * @param Dependency1 $dep1
- * ...
- * 
- * @Inject({Dependency1::class, Dependency2::class, ...})
+ * @Inject({
+ *     Dependency1::class,
+ *     Dependency2::class,
+ *     "config"
+ * })
  */
-public function __construct(Dependency1 $dep1, Dependency2 $dep2, ...)
-{
-    $this->dep1 = $dep1;
-    //...
+public function __construct(
+    protected Dependency1 $dep1,
+    protected Dependency2 $dep2,
+    protected array $config
+) {
 }
 ```
 
 The annotation `@Inject` is telling the factory to inject the services between curly braces.
-Valid service names should be provided, as registerd in the service manager.
+Valid service names should be provided, as registered in the service manager.
 
 To inject an array value from the service manager, you can use dot notation as below
 ```php
+use Dot\AnnotatedServices\Annotation\Inject;
+
 /**
  * @Inject({"config.debug"})
  */
@@ -93,6 +96,7 @@ The `name` field has to be the fully qualified class name.
 Every repository should extend `Doctrine\ORM\EntityRepository`.
 ```php
 use Doctrine\ORM\EntityRepository;
+use Dot\AnnotatedServices\Annotation\Entity;
 
 /**
  * @Entity(name="App\Entity\Example")
@@ -111,7 +115,6 @@ Using this approach, no service manager configuration is required. It uses the r
 In order to tell the abstract factory which services are to be created, you need to annotate the service class with the `@Service` annotation.
 ```php
 use Dot\AnnotatedServices\Annotation\Service;
-use Dot\AnnotatedServices\Annotation\Inject;
 
 /*
  * @Service

composer.json

@@ -33,12 +33,12 @@
     },
     "autoload": {
         "psr-4": {
-            "Dot\\AnnotatedServices\\": "src"
+            "Dot\\AnnotatedServices\\": "src/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "DotTest\\AnnotatedServices\\": "test"
+            "DotTest\\AnnotatedServices\\": "test/"
         }
     },
     "scripts": {