Merge pull request #6 from bitwise-operators/codestyle-and-version-fix

Fix codestyle issue and changelog

Author: Jeroen-G

.github/workflows/ci.yml

@@ -3,6 +3,7 @@ name: CI
 
 on:
   push:
+  pull_request:
 
 jobs:
   php-tests:

changelog.md

@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
+
+## [1.4.0]
 - Add option to use custom attribute classes
 
 ## [1.3.0]

src/Electrician.php

@@ -9,7 +9,7 @@
 use JeroenG\Autowire\Attribute\Configure as ConfigureAttribute;
 use JeroenG\Autowire\Attribute\ConfigureInterface as ConfigureAttributeInterface;
 use JeroenG\Autowire\Exception\FaultyWiringException;
-use Webmozart\Assert\Assert;
+use JeroenG\Autowire\Exception\InvalidAttributeException;
 
 final class Electrician
 {
@@ -22,8 +22,8 @@ public function __construct(
         private string $autowireAttribute = AutowireAttribute::class,
         private string $configureAttribute = ConfigureAttribute::class
     ) {        
-        self::assertValidAttributeImplementation($this->autowireAttribute, AutowireAttributeInterface::class);
-        self::assertValidAttributeImplementation($this->configureAttribute, ConfigureAttributeInterface::class);
+        self::checkValidAttributeImplementation($this->autowireAttribute, AutowireAttributeInterface::class);
+        self::checkValidAttributeImplementation($this->configureAttribute, ConfigureAttributeInterface::class);
     }
 
     public function connect(string $interface): Wire
@@ -62,13 +62,6 @@ public function configure(string $implementation): Configuration
 
         return new Configuration($implementation, $configurations);
     }
-    
-    private static function assertValidAttributeImplementation(string $className, string $attributeInterface): void
-    {
-        Assert::classExists($className);
-        Assert::notEmpty((new \ReflectionClass($className))->getAttributes(\Attribute::class));
-        Assert::isAOf($className, $attributeInterface, "{$className} : {$attributeInterface}");
-    }
 
     public function canAutowire(string $name): bool
     {
@@ -79,6 +72,24 @@ public function canConfigure(string $name): bool
     {
         return $this->classHasAttribute($name, $this->configureAttribute);
     }
+    
+    /**
+     * @throws InvalidAttributeException
+     */
+    private static function checkValidAttributeImplementation(string $className, string $attributeInterface): void
+    {
+        if (!class_exists($className)) {
+            throw InvalidAttributeException::doesNotExist($className);
+        }
+        
+        if (empty((new \ReflectionClass($className))->getAttributes(\Attribute::class))) {
+            throw InvalidAttributeException::isNotAnAttribute($className);
+        }
+        
+        if (!is_a($className, $attributeInterface, true)) {
+            throw InvalidAttributeException::doesNotImplementInterface($className, $attributeInterface);
+        }
+    }
 
     private function classHasAttribute(string $className, string $attributeName): bool
     {

src/Exception/InvalidAttributeException.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JeroenG\Autowire\Exception;
+
+final class InvalidAttributeException extends \RuntimeException
+{
+    public static function doesNotExist(string $class): self
+    {
+        return new self("Class $class does not exist");
+    }
+
+    public static function doesNotImplementInterface(string $class, string $interface): self
+    {
+        return new self("Class $class does not implement $interface");
+    }
+    
+    public static function isNotAnAttribute(string $class): self
+    {
+        return new self("Class $class is not an attribute");
+    }
+}

tests/Unit/ElectricianTest.php

@@ -9,6 +9,7 @@
 use JeroenG\Autowire\Crawler;
 use JeroenG\Autowire\Electrician;
 use JeroenG\Autowire\Exception\FaultyWiringException;
+use JeroenG\Autowire\Exception\InvalidAttributeException;
 use JeroenG\Autowire\Tests\Support\Attributes\CustomAutowire;
 use JeroenG\Autowire\Tests\Support\Attributes\CustomConfigure;
 use JeroenG\Autowire\Tests\Support\Subject\Contracts\GoodbyeInterface;
@@ -114,6 +115,31 @@ public function test_it_throws_exception_when_implementation_can_not_be_configur
         $electrician->configure(GoodbyeInterface::class);
     }
 
+    /** @dataProvider invalidAutowireAttributeProvider */
+    public function test_it_throws_an_exception_on_an_invalid_custom_autowire_attribute(string $invalidAttribute): void
+    {
+        $crawler = Crawler::in([SubjectDirectory::ALL]);
+
+        $this->expectException(InvalidAttributeException::class);
+
+        $electrician = new Electrician($crawler, $invalidAttribute);
+    }
+    
+    public function invalidAutowireAttributeProvider(): \Generator
+    {
+        yield 'text' => [
+            'Hello, World!',
+        ];
+        
+        yield 'non-attribute class' => [
+            HowDoYouDoInterface::class,
+        ];
+        
+        yield 'wrong attribute class' => [
+            CustomConfigure::class,
+        ];
+    }
+    
     public function test_it_can_tell_if_class_has_custom_autowire_attribute(): void
     {
         $crawler = Crawler::in([SubjectDirectory::ALL]);
@@ -133,6 +159,31 @@ public function test_it_can_connect_implementation_with_custom_autowire_attribut
         self::assertEquals(HowDoYouDoInterface::class, $wire->interface);
         self::assertEquals(MoonClass::class, $wire->implementation);
     }
+    
+    /** @dataProvider invalidConfigureAttributeProvider */
+    public function test_it_throws_an_exception_on_an_invalid_custom_configure_attribute(string $invalidAttribute): void
+    {
+        $crawler = Crawler::in([SubjectDirectory::ALL]);
+
+        $this->expectException(InvalidAttributeException::class);
+
+        $electrician = new Electrician(crawler: $crawler, configureAttribute: $invalidAttribute);
+    }
+    
+    public function invalidConfigureAttributeProvider(): \Generator
+    {
+        yield 'text' => [
+            'Hello, World!',
+        ];
+        
+        yield 'non-attribute class' => [
+            HowDoYouDoInterface::class,
+        ];
+        
+        yield 'wrong attribute class' => [
+            CustomAutowire::class,
+        ];
+    }
 
     public function test_it_can_tell_if_class_has_custom_configure_attribute(): void
     {