chore: Add make:entity and make:mapper

Author: ollieread

README.md

@@ -19,3 +19,43 @@ Concise is extensible and flexible, and will most likely serve as the basis for
 with many sensible defaults, and a sprinkle of magic that'll simplify using it based on certain conventions.
 It also comes with a driver for Laravel's auth functionality,
 and route entity binding (route model binding but for concise entities).
+
+## Getting Started
+
+First things first, create yourself an entity.
+
+```shell
+php artisan make:entity Blog
+```
+
+By default, it is assumed that the entity...
+
+- Is using an `id` field/column as its identifier
+- Is using the default connection
+- Has a table name that can be determined from the model name (`blogs` in this example)
+
+To change any of these, you can provide the options `--identity`, `--connection` and `--table` respectively.
+This command will create two files...
+
+- `app/Entities/Blog.php`
+- `app/Mappers/Entities/BlogMapper.php`
+
+Next you'll want to...
+
+- Open up your new `Blog` class, add the fields as properties, and add some getters and setters, if you want.
+- Open up your new `BlogMapper` class and update the `toObject()` and `toData()` methods.
+
+Concise entities can also make use of implicit route "model" binding, so there's no need to worry about manually doing
+that.
+To get a repository for a given entity, you can use the `EntityRepository` contextual attribute, like so.
+
+```php
+use Articulate\Concise\Attributes\EntityRepository;
+use Articulate\Concise\Contracts\Repository;
+
+class ExampleController {
+    public function __construct(
+        #[EntityRepository(Blog::class)] private Repository $blogRepository
+    ) {}
+}
+```

resources/stubs/entity.stub

@@ -0,0 +1,25 @@
+<?php
+
+namespace {{ namespace }};
+
+class {{ class }}
+{
+    private int ${{ identity }};
+
+    public function get{{ identityCamel }}(): int
+    {
+        return $this->{{ identity }};
+    }
+
+    public function has{{ identityCamel }}(): bool
+    {
+        return isset($this->{{ identity }});
+    }
+
+    public function set{{ identityCamel }}(int ${{ identity }}): self
+    {
+        $this->{{ identity }} = ${{ identity }};
+
+        return $this;
+    }
+}

resources/stubs/mapper.entity.connection.stub

@@ -0,0 +1,9 @@
+    /**
+     * Get the connection the entity should use
+     *
+     * @return string|null
+     */
+    public function connection(): ?string
+    {
+        return '{{ connection }}';
+    }

resources/stubs/mapper.entity.identity.stub

@@ -0,0 +1,9 @@
+    /**
+     * Get the name of the identity field
+     *
+     * @return string
+     */
+    public function identity(): string
+    {
+        return '{{ identity }}';
+    }

resources/stubs/mapper.entity.stub

@@ -0,0 +1,53 @@
+<?php
+
+namespace {{ namespace }};
+
+use Articulate\Concise\EntityMapper;
+
+/**
+ * @extends \Articulate\Concise\EntityMapper<{{ entityClass }}>
+ */
+class {{ class }}Mapper extends EntityMapper
+{
+    /**
+     * Get the class name this mapper represents.
+     *
+     * Returns the fully qualified class name of the object that this mapper is
+     * mapping.
+     *
+     * @return class-string<{{ entityClass }}>
+     */
+    public function class(): string
+    {
+        return {{ entityClass }}::class;
+    }
+
+    /**
+     * Convert a raw array to an object representation.
+     *
+     * @param array<string, mixed> $data
+     *
+     * @return object
+     *
+     * @phpstan-return {{ entityClass }}
+     */
+    public function toObject(array $data): object
+    {
+        return new {{ entityClass }}();
+    }
+
+    /**
+     * Convert an object representation to raw data.
+     *
+     * @param object            $object
+     *
+     * @phpstan-param {{ entityClass }} $object
+     *
+     * @return array<string, mixed>
+     */
+    public function toData(object $object): array
+    {
+        return [];
+    }
+    {{ extraMethods }}
+}

resources/stubs/mapper.entity.table.stub

@@ -0,0 +1,9 @@
+    /**
+     * Get the entities' database table
+     *
+     * @return string
+     */
+    public function table(): string
+    {
+        return '{{ table }}';
+    }

src/Attributes/EntityRepository.php

@@ -0,0 +1,44 @@
+<?php
+declare(strict_types=1);
+
+namespace Articulate\Concise\Attributes;
+
+use Articulate\Concise\Concise;
+use Articulate\Concise\Contracts\Repository;
+use Attribute;
+use Illuminate\Container\Container;
+use Illuminate\Contracts\Container\ContextualAttribute;
+
+/**
+ * @template EntityObject of object
+ */
+#[Attribute(Attribute::TARGET_PARAMETER)]
+final readonly class EntityRepository implements ContextualAttribute
+{
+    /**
+     * @var class-string<EntityObject>
+     */
+    public string $entity;
+
+    /**
+     * @param class-string<EntityObject> $entity
+     */
+    public function __construct(string $entity)
+    {
+        $this->entity = $entity;
+    }
+
+    /**
+     * @param \Articulate\Concise\Attributes\EntityRepository<EntityObject> $attribute
+     * @param \Illuminate\Container\Container                               $container
+     *
+     * @return \Articulate\Concise\Contracts\Repository<EntityObject>
+     *
+     * @throws \Illuminate\Contracts\Container\BindingResolutionException
+     */
+    public function resolve(self $attribute, Container $container): Repository
+    {
+        /** @noinspection NullPointerExceptionInspection */
+        return $container->make(Concise::class)->repository($attribute->entity);
+    }
+}

src/Commands/MakeEntityCommand.php

@@ -0,0 +1,112 @@
+<?php
+declare(strict_types=1);
+
+namespace Articulate\Concise\Commands;
+
+use Illuminate\Console\GeneratorCommand;
+use Illuminate\Support\Str;
+use Symfony\Component\Console\Attribute\AsCommand;
+
+#[AsCommand('make:entity')]
+class MakeEntityCommand extends GeneratorCommand
+{
+    /**
+     * The console command signature.
+     *
+     * @var string
+     */
+    protected $signature = 'make:entity {name : The name of the entity}
+        {--table= : The entity table}
+        {--identity= : The entity identity field}
+        {--connection= : The connection the entity uses}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Create a new entity';
+
+    protected $type = 'Entity';
+
+    /**
+     * Execute the console command.
+     *
+     * @return bool|null
+     *
+     * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
+     */
+    public function handle(): bool|null
+    {
+        if (parent::handle() === false) {
+            return false;
+        }
+
+        $this->call('make:mapper', [
+            'name'         => $this->argument('name') . 'Mapper',
+            'class'        => $this->argument('name'),
+            '--identity'   => $this->option('identity'),
+            '--table'      => $this->option('table'),
+            '--connection' => $this->option('connection'),
+        ]);
+
+        return null;
+    }
+
+    /**
+     * Get the stub file for the generator.
+     *
+     * @return string
+     */
+    protected function getStub(): string
+    {
+        return $this->resolveStubPath('/../../resources/stubs/entity.stub');
+    }
+
+    /**
+     * Resolve the fully qualified path to the stub.
+     *
+     * @param string $stub
+     *
+     * @return string
+     */
+    protected function resolveStubPath(string $stub): string
+    {
+        return file_exists($customPath = $this->laravel->basePath(trim($stub, '/')))
+            ? $customPath
+            : __DIR__ . $stub;
+    }
+
+    /**
+     * Get the default namespace for the class.
+     *
+     * @param string $rootNamespace
+     *
+     * @return string
+     */
+    protected function getDefaultNamespace($rootNamespace): string
+    {
+        return $rootNamespace . '\\Entities';
+    }
+
+    /**
+     * Build the class with the given name.
+     *
+     * @param string $name
+     *
+     * @return string
+     *
+     * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
+     */
+    protected function buildClass($name): string
+    {
+        /** @var string $identity */
+        $identity = $this->option('identity') ?? 'id';
+
+        return str_replace(
+            ['{{ identityCamel }}', '{{ identity }}'],
+            [$identity, Str::camel($identity)],
+            parent::buildClass($name)
+        );
+    }
+}