Добавлена поддержка запоминания языка для аккаунта

Обновлена минимальная версия Yii2 Удалено немного хлама от Yii2 Advanced Исправлены некоторые тесты
2024-11-30 02:32:26 +05:30 · 2016-05-13 12:03:00 +03:00 · 2016-05-13 12:03:00 +03:00 · ecd92b8fda
commit ecd92b8fda
parent 65382fa1ce
22 changed files with 175 additions and 124 deletions
--- a/.dockerignore
+++ b/.dockerignore
@ -3,8 +3,8 @@

 # vendor будет заполнен уже внутри контейнера
 vendor
-# frontend и его node_modules внутри контейнера не нужны
-frontend
+# node_modules для этого контейнера не нужны
+node_modules

 # Все -local файлы
 */config/*-local.php
--- a/api/controllers/AccountsController.php
+++ b/api/controllers/AccountsController.php
@ -52,6 +52,7 @@ class AccountsController extends Controller {
            'uuid' => $account->uuid,
            'username' => $account->username,
            'email' => $account->email,
+            'lang' => $account->lang,
            'shouldChangePassword' => $account->password_hash_strategy === Account::PASS_HASH_STRATEGY_OLD_ELY,
            'isActive' => $account->status === Account::STATUS_ACTIVE,
            'passwordChangedAt' => $account->password_changed_at,
--- a/api/models/PasswordResetRequestForm.php
+++ b/api/models/PasswordResetRequestForm.php
@ -1,60 +0,0 @@
-<?php
-namespace api\models;
-
-use common\models\Account;
-use yii\base\Model;
-
-/**
- * Password reset request form
- */
-class PasswordResetRequestForm extends Model
-{
-    public $email;
-
-    /**
-     * @inheritdoc
-     */
-    public function rules()
-    {
-        return [
-            ['email', 'filter', 'filter' => 'trim'],
-            ['email', 'required'],
-            ['email', 'email'],
-            ['email', 'exist',
-                'targetClass' => '\common\models\User',
-                'filter' => ['status' => Account::STATUS_ACTIVE],
-                'message' => 'There is no user with such email.'
-            ],
-        ];
-    }
-
-    /**
-     * Sends an email with a link, for resetting the password.
-     *
-     * @return boolean whether the email was send
-     */
-    public function sendEmail()
-    {
-        /* @var $user Account */
-        $user = Account::findOne([
-            'status' => Account::STATUS_ACTIVE,
-            'email' => $this->email,
-        ]);
-
-        if ($user) {
-            if (!Account::isPasswordResetTokenValid($user->password_reset_token)) {
-                $user->generatePasswordResetToken();
-            }
-
-            if ($user->save()) {
-                return \Yii::$app->mailer->compose(['html' => 'passwordResetToken-html', 'text' => 'passwordResetToken-text'], ['user' => $user])
-                    ->setFrom([\Yii::$app->params['supportEmail'] => \Yii::$app->name . ' robot'])
-                    ->setTo($this->email)
-                    ->setSubject('Password reset for ' . \Yii::$app->name)
-                    ->send();
-            }
-        }
-
-        return false;
-    }
-}
--- a/api/models/RegistrationForm.php
+++ b/api/models/RegistrationForm.php
@ -7,6 +7,7 @@ use common\components\UserFriendlyRandomKey;
 use common\models\Account;
 use common\models\confirmations\RegistrationConfirmation;
 use common\models\EmailActivation;
+use common\validators\LanguageValidator;
 use common\validators\PasswordValidate;
 use Ramsey\Uuid\Uuid;
 use Yii;
@ -20,6 +21,7 @@ class RegistrationForm extends ApiForm {
    public $password;
    public $rePassword;
    public $rulesAgreement;
+    public $lang;

    public function rules() {
        return [
@ -33,6 +35,8 @@ class RegistrationForm extends ApiForm {
            ['rePassword', 'required', 'message' => 'error.rePassword_required'],
            ['password', PasswordValidate::class],
            ['rePassword', 'validatePasswordAndRePasswordMatch'],
+
+            ['lang', LanguageValidator::class],
        ];
    }

@ -75,6 +79,7 @@ class RegistrationForm extends ApiForm {
            $account->email = $this->email;
            $account->username = $this->username;
            $account->password = $this->password;
+            $account->lang = $this->lang;
            $account->status = Account::STATUS_REGISTERED;
            if (!$account->save()) {
                throw new ErrorException('Account not created.');
--- a/common/config/bootstrap.php
+++ b/common/config/bootstrap.php
@ -2,3 +2,4 @@
 Yii::setAlias('common', dirname(__DIR__));
 Yii::setAlias('api', dirname(dirname(__DIR__)) . '/api');
 Yii::setAlias('console', dirname(dirname(__DIR__)) . '/console');
+Yii::setAlias('frontend', dirname(dirname(__DIR__)) . '/frontend');
--- a/common/mail/passwordResetToken-html.php
+++ b/common/mail/passwordResetToken-html.php
@ -1,15 +0,0 @@
-<?php
-use yii\helpers\Html;
-
-/* @var $this yii\web\View */
-/* @var $user common\models\Account */
-
-$resetLink = Yii::$app->urlManager->createAbsoluteUrl(['site/reset-password', 'token' => $user->password_reset_token]);
-?>
-<div class="password-reset">
-    <p>Hello <?= Html::encode($user->email) ?>,</p>
-
-    <p>Follow the link below to reset your password:</p>
-
-    <p><?= Html::a(Html::encode($resetLink), $resetLink) ?></p>
-</div>
--- a/common/mail/passwordResetToken-text.php
+++ b/common/mail/passwordResetToken-text.php
@ -1,12 +0,0 @@
-<?php
-
-/* @var $this yii\web\View */
-/* @var $user common\models\Account */
-
-$resetLink = Yii::$app->urlManager->createAbsoluteUrl(['site/reset-password', 'token' => $user->password_reset_token]);
-?>
-Hello <?= $user->email ?>,
-
-Follow the link below to reset your password:
-
-<?= $resetLink ?>
--- a/common/models/Account.php
+++ b/common/models/Account.php
@ -2,6 +2,7 @@
 namespace common\models;

 use common\components\UserPass;
+use common\validators\LanguageValidator;
 use damirka\JWT\UserTrait as UserJWTTrait;
 use Ely\Yii2\TempmailValidator;
 use Yii;
@ -17,7 +18,7 @@ use yii\db\ActiveRecord;
 * @property string  $email
 * @property string  $password_hash
 * @property integer $password_hash_strategy
- * @property string  $password_reset_token
+ * @property string  $lang
 * @property integer $status
 * @property integer $created_at
 * @property integer $updated_at
@ -73,6 +74,9 @@ class Account extends ActiveRecord {
            [['email'], 'email', 'checkDNS' => true, 'enableIDN' => true, 'message' => 'error.email_invalid'],
            [['email'], TempmailValidator::class, 'message' => 'error.email_is_tempmail'],
            [['email'], 'unique', 'message' => 'error.email_not_available'],
+
+            [['lang'], LanguageValidator::class],
+            [['lang'], 'default', 'value' => 'en'],
        ];
    }

--- a/common/validators/LanguageValidator.php
+++ b/common/validators/LanguageValidator.php
@ -0,0 +1,38 @@
+<?php
+namespace common\validators;
+
+use Yii;
+use yii\validators\Validator;
+
+class LanguageValidator extends Validator {
+
+    public $message = 'error.unsupported_language';
+
+    protected function validateValue($value) {
+        if (empty($value)) {
+            return null;
+        }
+
+        $files = $this->getFilesNames();
+        if (in_array($value, $files)) {
+            return null;
+        }
+
+        return [$this->message, []];
+    }
+
+    protected function getFilesNames() {
+        $files = array_values(array_filter(scandir($this->getFolderPath()), function(&$value) {
+            return $value !== '..' && $value !== '.';
+        }));
+
+        return array_map(function($value) {
+            return basename($value, '.json');
+        }, $files);
+    }
+
+    protected function getFolderPath() {
+        return Yii::getAlias('@frontend/src/i18n');
+    }
+
+}
--- a/composer.json
+++ b/composer.json
@ -15,7 +15,7 @@
    "minimum-stability": "stable",
    "require": {
        "php": "~7.0.6",
-        "yiisoft/yii2": "~2.0.6",
+        "yiisoft/yii2": "~2.0.8",
        "yiisoft/yii2-bootstrap": "*",
        "yiisoft/yii2-swiftmailer": "*",
        "ramsey/uuid": "~3.1",
--- a/console/migrations/m160512_194546_account_language.php
+++ b/console/migrations/m160512_194546_account_language.php
@ -0,0 +1,17 @@
+<?php
+
+use console\db\Migration;
+
+class m160512_194546_account_language extends Migration {
+
+    public function safeUp() {
+        $this->addColumn('{{%accounts}}', 'lang', $this->string(5)->notNull()->defaultValue('en')->after('password_hash_strategy'));
+        $this->dropColumn('{{%accounts}}', 'password_reset_token');
+    }
+
+    public function safeDown() {
+        $this->dropColumn('{{%accounts}}', 'lang');
+        $this->addColumn('{{%accounts}}', 'password_reset_token', $this->string()->unique());
+    }
+
+}
--- a/tests/codeception/api/functional/AccountsCurrentCest.php
+++ b/tests/codeception/api/functional/AccountsCurrentCest.php
@ -26,8 +26,12 @@ class AccountsCurrentCest {
            'id' => 1,
            'username' => 'Admin',
            'email' => 'admin@ely.by',
+            'lang' => 'en',
            'shouldChangePassword' => false,
+            'isActive' => true,
+            'hasMojangUsernameCollision' => false,
        ]);
+        $I->canSeeResponseJsonMatchesJsonPath('$.passwordChangedAt');
    }

 }
--- a/tests/codeception/api/functional/RegisterCest.php
+++ b/tests/codeception/api/functional/RegisterCest.php
@ -214,6 +214,7 @@ class RegisterCest {
            'password' => 'some_password',
            'rePassword' => 'some_password',
            'rulesAgreement' => true,
+            'lang' => 'ru',
        ]);
        $I->canSeeResponseCodeIs(200);
        $I->canSeeResponseIsJson();
--- a/tests/codeception/api/unit/models/ChangePasswordFormTest.php
+++ b/tests/codeception/api/unit/models/ChangePasswordFormTest.php
@ -85,9 +85,10 @@ class ChangePasswordFormTest extends DbTestCase {
            'newRePassword' => 'my-new-password',
        ]);
        $this->specify('successfully change password with legacy hash strategy', function() use ($model, $account) {
+            $callTime = time();
            expect('form should return true', $model->changePassword())->true();
            expect('new password should be successfully stored into account', $account->validatePassword('my-new-password'))->true();
-            expect('password change time updated', $account->password_changed_at)->greaterOrEquals(time() - 2);
+            expect('password change time updated', $account->password_changed_at)->greaterOrEquals($callTime);
        });
    }

--- a/tests/codeception/api/unit/models/RegistrationFormTest.php
+++ b/tests/codeception/api/unit/models/RegistrationFormTest.php
@ -68,19 +68,43 @@ class RegistrationFormTest extends DbTestCase {
            'password' => 'some_password',
            'rePassword' => 'some_password',
            'rulesAgreement' => true,
+            'lang' => 'ru',
        ]);

-        $user = $model->signup();
+        $account = $model->signup();

-        expect('user should be valid', $user)->isInstanceOf(Account::class);
-        expect('password should be correct', $user->validatePassword('some_password'))->true();
-        expect('uuid is set', $user->uuid)->notEmpty();
+        $this->expectSuccessRegistration($account);
+        expect('lang is set', $account->lang)->equals('ru');
+    }
+
+    public function testSignupWithDefaultLanguage() {
+        $model = new RegistrationForm([
+            'username' => 'some_username',
+            'email' => 'some_email@example.com',
+            'password' => 'some_password',
+            'rePassword' => 'some_password',
+            'rulesAgreement' => true,
+        ]);
+
+        $account = $model->signup();
+
+        $this->expectSuccessRegistration($account);
+        expect('lang is set', $account->lang)->equals('en');
+    }
+
+    /**
+     * @param Account|null $account
+     */
+    private function expectSuccessRegistration($account) {
+        expect('user should be valid', $account)->isInstanceOf(Account::class);
+        expect('password should be correct', $account->validatePassword('some_password'))->true();
+        expect('uuid is set', $account->uuid)->notEmpty();
        expect('user model exists in database', Account::find()->andWhere([
            'username' => 'some_username',
            'email' => 'some_email@example.com',
        ])->exists())->true();
        expect('email activation code exists in database', EmailActivation::find()->andWhere([
-            'account_id' => $user->id,
+            'account_id' => $account->id,
            'type' => EmailActivation::TYPE_REGISTRATION_EMAIL_CONFIRMATION,
        ])->exists())->true();
        expect_file('message file exists', $this->getMessageFile())->exists();
--- a/tests/codeception/common/fixtures/data/accounts.php
+++ b/tests/codeception/common/fixtures/data/accounts.php
@ -7,7 +7,7 @@ return [
        'email' => 'admin@ely.by',
        'password_hash' => '$2y$13$CXT0Rkle1EMJ/c1l5bylL.EylfmQ39O5JlHJVFpNn618OUS1HwaIi', # password_0
        'password_hash_strategy' => \common\models\Account::PASS_HASH_STRATEGY_YII2,
-        'password_reset_token' => null,
+        'lang' => 'en',
        'status' => \common\models\Account::STATUS_ACTIVE,
        'created_at' => 1451775316,
        'updated_at' => 1451775316,
@ -20,7 +20,7 @@ return [
        'email' => 'erickskrauch123@yandex.ru',
        'password_hash' => '133c00c463cbd3e491c28cb653ce4718', # 12345678
        'password_hash_strategy' => \common\models\Account::PASS_HASH_STRATEGY_OLD_ELY,
-        'password_reset_token' => null,
+        'lang' => 'en',
        'status' => \common\models\Account::STATUS_ACTIVE,
        'created_at' => 1385225069,
        'updated_at' => 1385225069,
@ -33,7 +33,7 @@ return [
        'email' => 'achristiansen@gmail.com',
        'password_hash' => '$2y$13$2rYkap5T6jG8z/mMK8a3Ou6aZxJcmAaTha6FEuujvHEmybSHRzW5e', # password_0
        'password_hash_strategy' => \common\models\Account::PASS_HASH_STRATEGY_YII2,
-        'password_reset_token' => null,
+        'lang' => 'en',
        'status' => \common\models\Account::STATUS_REGISTERED,
        'created_at' => 1453146616,
        'updated_at' => 1453146616,
@ -46,7 +46,7 @@ return [
        'email' => 'jon@ely.by',
        'password_hash' => '$2y$13$2rYkap5T6jG8z/mMK8a3Ou6aZxJcmAaTha6FEuujvHEmybSHRzW5e', # password_0
        'password_hash_strategy' => \common\models\Account::PASS_HASH_STRATEGY_YII2,
-        'password_reset_token' => null,
+        'lang' => 'en',
        'status' => \common\models\Account::STATUS_REGISTERED,
        'created_at' => 1457890086,
        'updated_at' => 1457890086,
@ -58,7 +58,7 @@ return [
        'email' => 'notch@mojang.com',
        'password_hash' => '$2y$13$2rYkap5T6jG8z/mMK8a3Ou6aZxJcmAaTha6FEuujvHEmybSHRzW5e', # password_0
        'password_hash_strategy' => \common\models\Account::PASS_HASH_STRATEGY_YII2,
-        'password_reset_token' => null,
+        'lang' => 'en',
        'status' => \common\models\Account::STATUS_ACTIVE,
        'created_at' => 1462891432,
        'updated_at' => 1462891432,
@ -70,7 +70,7 @@ return [
        'email' => '23derevo@gmail.com',
        'password_hash' => '$2y$13$2rYkap5T6jG8z/mMK8a3Ou6aZxJcmAaTha6FEuujvHEmybSHRzW5e', # password_0
        'password_hash_strategy' => \common\models\Account::PASS_HASH_STRATEGY_YII2,
-        'password_reset_token' => null,
+        'lang' => 'en',
        'status' => \common\models\Account::STATUS_ACTIVE,
        'created_at' => 1462891612,
        'updated_at' => 1462891612,
--- a/tests/codeception/common/templates/fixtures/account.php
+++ b/tests/codeception/common/templates/fixtures/account.php
@ -12,7 +12,7 @@ return [
    'email' => $faker->email,
    'password_hash' => $security->generatePasswordHash('password_' . $index),
    'password_hash_strategy' => \common\models\Account::PASS_HASH_STRATEGY_YII2,
-    'password_reset_token' => NULL,
+    'lang' => 'en',
    'auth_key' => $security->generateRandomString(),
    'status' => \common\models\Account::STATUS_ACTIVE,
    'created_at' => time(),
--- a/tests/codeception/common/unit/TestCase.php
+++ b/tests/codeception/common/unit/TestCase.php
@ -1,11 +1,8 @@
 <?php
-
 namespace tests\codeception\common\unit;

-/**
- * @inheritdoc
- */
-class TestCase extends \yii\codeception\TestCase
-{
+class TestCase extends \yii\codeception\TestCase {
+
    public $appConfig = '@tests/codeception/config/common/unit.php';
+
 }
--- a/tests/codeception/common/unit/fixtures/data/i18n/en.json
+++ b/tests/codeception/common/unit/fixtures/data/i18n/en.json
@ -0,0 +1,3 @@
+{
+    "testString": "testValue"
+}
--- a/tests/codeception/common/unit/fixtures/data/i18n/ru.json
+++ b/tests/codeception/common/unit/fixtures/data/i18n/ru.json
@ -0,0 +1,3 @@
+{
+    "testString": "тестовоеЗначение"
+}
--- a/tests/codeception/common/unit/fixtures/data/models/user.php
+++ b/tests/codeception/common/unit/fixtures/data/models/user.php
@ -1,14 +0,0 @@
-<?php
-
-return [
-    [
-        'username' => 'bayer.hudson',
-        'auth_key' => 'HP187Mvq7Mmm3CTU80dLkGmni_FUH_lR',
-        //password_0
-        'password_hash' => '$2y$13$EjaPFBnZOQsHdGuHI.xvhuDp1fHpo8hKRSk6yshqa9c5EG8s3C3lO',
-        'password_reset_token' => 'ExzkCOaYc1L8IOBs4wdTGGbgNiG3Wz1I_1402312317',
-        'created_at' => '1402312317',
-        'updated_at' => '1402312317',
-        'email' => 'nicole.paucek@schultz.info',
-    ],
-];
--- a/tests/codeception/common/unit/validators/LanguageValidatorTest.php
+++ b/tests/codeception/common/unit/validators/LanguageValidatorTest.php
@ -0,0 +1,53 @@
+<?php
+namespace codeception\common\unit\validators;
+
+use Codeception\Specify;
+use common\validators\LanguageValidator;
+use ReflectionClass;
+use tests\codeception\common\unit\TestCase;
+
+class LanguageValidatorTest extends TestCase {
+    use Specify;
+
+    public function testGetFilesNames() {
+        $this->specify('get list of 2 languages: ru and en', function() {
+            $model = $this->createModelWithFixturePath();
+            expect($this->callProtected($model, 'getFilesNames'))->equals(['en', 'ru']);
+        });
+    }
+
+    public function testValidateValue() {
+        $this->specify('get null, because language is supported', function() {
+            $model = $this->createModelWithFixturePath();
+            expect($this->callProtected($model, 'validateValue', 'ru'))->null();
+        });
+
+        $this->specify('get error message, because language is unsupported', function() {
+            $model = $this->createModelWithFixturePath();
+            expect($this->callProtected($model, 'validateValue', 'by'))->equals([
+                $model->message,
+                [],
+            ]);
+        });
+    }
+
+    /**
+     * @return LanguageValidator
+     */
+    private function createModelWithFixturePath() {
+        return new class extends LanguageValidator {
+            public function getFolderPath() {
+                return __DIR__ . '/../fixtures/data/i18n';
+            }
+        };
+    }
+
+    private function callProtected($object, string $function, ...$args) {
+        $class = new ReflectionClass($object);
+        $method = $class->getMethod($function);
+        $method->setAccessible(true);
+
+        return $method->invokeArgs($object, $args);
+    }
+
+}