Use Cycle ORM (#23)

Co-authored-by: roxblnfk <[email protected]>
yiisoft · Jan 22, 2020 · 08bb6ad · 08bb6ad
2 parents 70433e3 + 4ebc30a
commit 08bb6ad
Show file tree

Hide file tree

Showing 7 changed files with 162 additions and 38 deletions.
diff --git a/composer.json b/composer.json
@@ -44,7 +44,8 @@
         "yiisoft/var-dumper": "^3.0@dev",
         "yiisoft/view": "^3.0@dev",
         "yiisoft/yii-console": "^3.0@dev",
-        "yiisoft/yii-web": "^3.0@dev"
+        "yiisoft/yii-web": "^3.0@dev",
+        "yiisoft/yii-cycle": "^3.0@dev"
     },
     "require-dev": {
     },

diff --git a/config/common.php b/config/common.php
@@ -4,6 +4,7 @@
 use App\Factory\MailerFactory;
 use App\Parameters;
 use Psr\Log\LoggerInterface;
+use Yiisoft\Aliases\Aliases;
 use Yiisoft\Cache\ArrayCache;
 use Yiisoft\Cache\Cache;
 use Yiisoft\Cache\CacheInterface;
@@ -16,6 +17,9 @@
  */
 
 return [
+    Aliases::class => $params['aliases'],
+    Psr\SimpleCache\CacheInterface::class => ArrayCache::class,
+    CacheInterface::class => Cache::class,
     Parameters::class => static function () use ($params) {
         return new Parameters($params);
     },

diff --git a/config/params.php b/config/params.php
@@ -1,5 +1,7 @@
 <?php
 
+use App\Command\User\CreateCommand;
+
 return [
     'mailer' => [
         'host' => 'smtp.example.com',
@@ -20,5 +22,39 @@
 
     'session' => [
         'options' => ['cookie_secure' => 0],
-    ]
+    ],
+
+    'commands' => [
+        'user/create' => CreateCommand::class,
+    ],
+
+    // cycle DBAL config
+    'cycle.dbal' => [
+        'default' => 'default',
+        'aliases' => [],
+        'databases' => [
+            'default' => ['connection' => 'sqlite']
+        ],
+        'connections' => [
+            'sqlite' => [
+                'driver' => \Spiral\Database\Driver\SQLite\SQLiteDriver::class,
+                'connection' => 'sqlite:@runtime/database.db',
+                'username' => '',
+                'password' => '',
+            ]
+        ],
+    ],
+    // cycle common config
+    'cycle.common' => [
+        'entityPaths' => [
+            '@src/Entity'
+        ],
+    ],
+    // cycle migration config
+    'cycle.migrations' => [
+        'directory' => '@root/migrations',
+        'namespace' => 'App\\Migration',
+        'table' => 'migration',
+        'safe' => false,
+    ],
 ];
diff --git a/src/Command/User/CreateCommand.php b/src/Command/User/CreateCommand.php
@@ -0,0 +1,59 @@
+<?php
+
+namespace App\Command\User;
+
+use App\Entity\User;
+use Cycle\ORM\ORMInterface;
+use Cycle\ORM\Transaction;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+class CreateCommand extends Command
+{
+    private const EXIT_CODE_FAILED_TO_PERSIST = 1;
+
+    private $orm;
+
+    protected static $defaultName = 'user/create';
+
+    public function __construct(ORMInterface $orm)
+    {
+        parent::__construct();
+        $this->orm = $orm;
+    }
+
+    public function configure(): void
+    {
+        $this
+            ->setDescription('Creates a user')
+            ->setHelp('This command allows you to create a user')
+            ->addArgument('login', InputArgument::REQUIRED, 'Login')
+            ->addArgument('password', InputArgument::REQUIRED, 'Password');
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $io = new SymfonyStyle($input, $output);
+
+        $login = $input->getArgument('login');
+        $password = $input->getArgument('password');
+
+        $user = new User();
+        $user->setLogin($login);
+        $user->setPassword($password);
+
+        try {
+            $transaction = new Transaction($this->orm);
+            $transaction->persist($user);
+            $transaction->run();
+            $io->success('User created');
+        } catch (\Throwable $t) {
+            $io->error($t->getMessage());
+            return self::EXIT_CODE_FAILED_TO_PERSIST;
+        }
+    }
+}
diff --git a/src/Entity/User.php b/src/Entity/User.php
@@ -1,20 +1,55 @@
 <?php
+
 namespace App\Entity;
 
+use Cycle\Annotated\Annotation\Column;
+use Cycle\Annotated\Annotation\Entity;
+use Cycle\Annotated\Annotation\Table;
+use Cycle\Annotated\Annotation\Table\Index;
 use Yiisoft\Security\PasswordHasher;
+use Yiisoft\Security\Random;
 use Yiisoft\Auth\IdentityInterface;
 
+/**
+ * @Entity(repository="App\Repository\UserRepository")
+ * @Table(
+ *     indexes={
+ *         @Index(columns={"login"}, unique=true),
+ *         @Index(columns={"token"}, unique=true)
+ *     }
+ * )
+ */
 class User implements IdentityInterface
 {
-    private string $id;
-    private ?string $token = null;
-    private string $login;
-    private ?string $passwordHash = null;
+    /**
+     * @Column(type="primary")
+     * @var int
+     */
+    private $id;
+
+    /**
+     * @Column(type="string(128)")
+     * @var string
+     */
+    private $token;
+
+    /**
+     * @Column(type="string(48)")
+     * @var string
+     */
+    private $login;
 
-    public function __construct(string $id, string $login)
+    /**
+     * @Column(type="string")
+     * @var string
+     */
+    private $passwordHash;
+
+    public function __construct()
     {
-        $this->id = $id;
-        $this->login = $login;
+        if (!isset($this->token)) {
+            $this->resetToken();
+        }
     }
 
     public function getId(): ?string
@@ -27,16 +62,21 @@ public function getToken(): ?string
         return $this->token;
     }
 
-    public function setToken(string $token): void
+    public function resetToken(): void
     {
-        $this->token = $token;
+        $this->token = Random::string(128);
     }
 
     public function getLogin(): string
     {
         return $this->login;
     }
 
+    public function setLogin(string $login): void
+    {
+        $this->login = $login;
+    }
+
     public function validatePassword(string $password): bool
     {
         if ($this->passwordHash === null) {

diff --git a/src/Factory/AppRouterFactory.php b/src/Factory/AppRouterFactory.php
@@ -25,6 +25,7 @@ public function __invoke(ContainerInterface $container)
             Route::get('/test/{id:\w+}')
                 ->to(new ActionCaller(SiteController::class, 'testParameter', $container))
                 ->name('site/test'),
+
             Route::methods([Method::GET, Method::POST], '/login')
                 ->to(new ActionCaller(AuthController::class, 'login', $container))
                 ->name('site/login'),

diff --git a/src/Repository/UserRepository.php b/src/Repository/UserRepository.php
@@ -3,51 +3,34 @@
 namespace App\Repository;
 
 use App\Entity\User;
+use Cycle\ORM\ORMInterface;
+use Cycle\ORM\Select;
 use Yiisoft\Auth\IdentityInterface;
 use Yiisoft\Auth\IdentityRepositoryInterface;
 
-class UserRepository implements IdentityRepositoryInterface
+class UserRepository extends Select\Repository implements IdentityRepositoryInterface
 {
-    private const IDENTITIES = [
-        [
-            'id' => '1',
-            'token' => 'test1',
-            'login' => 'samdark',
-            'password' => 'qwerty',
-        ],
-        [
-            'id' => '2',
-            'token' => 'test2',
-            'login' => 'hiqsol',
-            'password' => 'qwerty',
-        ],
-    ];
+    public function __construct(ORMInterface $orm, $role = User::class)
+    {
+        parent::__construct(new Select($orm, $role));
+    }
 
     private function findIdentityBy(string $field, string $value): ?IdentityInterface
     {
-        foreach (self::IDENTITIES as $identity) {
-            if ($identity[$field] === $value) {
-                $user = new User($identity['id'], $identity['login']);
-                $user->setToken($identity['token']);
-                $user->setPassword($identity['password']);
-                return $user;
-            }
-        }
-
-        return null;
+        return $this->findOne([$field => $value]);
     }
 
     public function findIdentity(string $id): ?IdentityInterface
     {
-        return $this->findIdentityBy('id', $id);
+        return $this->findByPK($id);
     }
 
     public function findIdentityByToken(string $token, string $type): ?IdentityInterface
     {
         return $this->findIdentityBy('token', $token);
     }
 
-    public function findByLogin(string $login): ?User
+    public function findByLogin(string $login): ?IdentityInterface
     {
         return $this->findIdentityBy('login', $login);
     }