chore!: drop support for entity name

Author: calebdw

README.md

@@ -226,12 +226,12 @@ use CalebDW\SqlEntities\Facades\SqlEntity;
 use CalebDW\SqlEntities\SqlEntityManager;
 use CalebDW\SqlEntities\View;
 
-// Create a single entity by name, class, or instance
-SqlEntity::create('recent_orders_view');
+// Create a single entity by class or instance
+SqlEntity::create(RecentOrdersView::class);
 resolve(SqlEntityManager::class)->create(RecentOrdersView::class);
 resolve('sql-entities')->create(new RecentOrdersView());
 
-// Similarly, you can drop a single entity using the name, class, or instance
+// Similarly, you can drop a single entity using the class or instance
 SqlEntity::drop(RecentOrdersView::class);
 
 // Create or drop all entities

src/SqlEntityManager.php

@@ -14,55 +14,59 @@
 use Illuminate\Database\Connection;
 use Illuminate\Database\DatabaseManager;
 use Illuminate\Support\Collection;
+use Illuminate\Support\ItemNotFoundException;
 use InvalidArgumentException;
 
 class SqlEntityManager
 {
+    /** @var Collection<class-string<SqlEntity>, SqlEntity> */
+    public readonly Collection $entities;
+
     /**
      * The active grammar instances.
      *
      * @var array<string, Grammar>
      */
     protected array $grammars = [];
 
+    /** @param Collection<int, SqlEntity> $entities */
     public function __construct(
-        /** @var Collection<int, SqlEntity> */
-        public readonly Collection $entities,
+        Collection $entities,
         protected DatabaseManager $db,
     ) {
+        $this->entities = $entities
+            ->keyBy(fn ($entity) => $entity::class);
     }
 
-    /** @throws InvalidArgumentException if the entity is not found. */
-    public function get(string $name, ?string $connection = null): SqlEntity
+    /**
+     * Get the entity by class.
+     *
+     * @param class-string<SqlEntity> $name
+     * @throws ItemNotFoundException
+     */
+    public function get(string $name): SqlEntity
     {
-        $entity = $this->entities->firstWhere(
-            fn (SqlEntity $e) => $e->name() === $name
-                && $e->connectionName() === $connection,
-        );
+        $entity = $this->entities->get($name);
 
-        throw_if(
-            $entity === null,
-            new InvalidArgumentException("Entity [{$name}] not found."),
-        );
+        if ($entity === null) {
+            throw new ItemNotFoundException("Entity [{$name}] not found.");
+        }
 
         return $entity;
     }
 
     /**
      * Create an entity.
      *
-     * @param class-string<SqlEntity>|string|SqlEntity $entity The entity name, class, or instance.
-     * @throws InvalidArgumentException if the entity is not found.
+     * @param class-string<SqlEntity>|SqlEntity $entity
+     * @throws ItemNotFoundException
      */
     public function create(SqlEntity|string $entity): void
     {
         if (is_string($entity)) {
-            $entity = class_exists($entity)
-                ? resolve($entity)
-                : $this->get($entity);
+            $entity = $this->get($entity);
         }
 
-        assert($entity instanceof SqlEntity);
         $connection = $this->connection($entity);
 
         if (! $entity->creating($connection)) {
@@ -78,18 +82,15 @@ public function create(SqlEntity|string $entity): void
     /**
      * Drop an entity.
      *
-     * @param class-string<SqlEntity>|string|SqlEntity $entity The entity name, class, or instance.
-     * @throws InvalidArgumentException if the entity is not found.
+     * @param class-string<SqlEntity>|SqlEntity $entity
+     * @throws ItemNotFoundException
      */
     public function drop(SqlEntity|string $entity): void
     {
         if (is_string($entity)) {
-            $entity = class_exists($entity)
-                ? resolve($entity)
-                : $this->get($entity);
+            $entity = $this->get($entity);
         }
 
-        assert($entity instanceof SqlEntity);
         $connection = $this->connection($entity);
 
         if (! $entity->dropping($connection)) {
@@ -144,9 +145,7 @@ protected function createGrammar(string $driver, Connection $connection): Gramma
             'pgsql'   => new PostgresGrammar($connection),
             'sqlite'  => new SQLiteGrammar($connection),
             'sqlsrv'  => new SqlServerGrammar($connection),
-            default   => throw new InvalidArgumentException(
-                "Unsupported driver [{$driver}].",
-            ),
+            default   => throw new InvalidArgumentException("Unsupported driver [{$driver}]."),
         };
     }
 }

tests/Feature/SqlEntityManagerTest.php

@@ -7,6 +7,7 @@
 use CalebDW\SqlEntities\View;
 use Illuminate\Database\Connection;
 use Illuminate\Database\DatabaseManager;
+use Illuminate\Support\ItemNotFoundException;
 use Workbench\Database\Entities\views\FooConnectionUserView;
 use Workbench\Database\Entities\views\UserView;
 
@@ -39,21 +40,18 @@
     ->not->toBeEmpty();
 
 describe('get', function () {
-    it('returns the entity by name', function () {
-        $entity = test()->manager->get('user_view');
+    it('returns the entity by class', function (string $class) {
+        $entity = test()->manager->get($class);
 
-        expect($entity)->toBeInstanceOf(UserView::class);
-    });
-
-    it('returns the entity by name and connection', function () {
-        $entity = test()->manager->get('user_view', 'foo');
-
-        expect($entity)->toBeInstanceOf(FooConnectionUserView::class);
-    });
+        expect($entity)->toBeInstanceOf($class);
+    })->with([
+        UserView::class,
+        FooConnectionUserView::class,
+    ]);;
 
     it('throws an exception for unknown entity', function () {
         $entity = test()->manager->get('unknown');
-    })->throws(InvalidArgumentException::class, 'Entity [unknown] not found.');
+    })->throws(ItemNotFoundException::class, 'Entity [unknown] not found.');
 });
 
 describe('create', function () {
@@ -66,7 +64,6 @@
 
         test()->manager->create($entity);
     })->with('drivers')->with([
-        'name'   => 'user_view',
         'class'  => UserView::class,
         'entity' => new UserView(),
     ]);
@@ -93,7 +90,6 @@
 
         test()->manager->drop($entity);
     })->with('drivers')->with([
-        'name'   => 'user_view',
         'class'  => UserView::class,
         'entity' => new UserView(),
     ]);