Merge pull request #43 from justcoded/develop

removed base module, added app key generator

Author: aprokopenko

.env.example

@@ -1,6 +1,6 @@
 APP_ENV=dev
 APP_DEBUG=true
-APP_KEY=wUZvVVKJyHFGDB9qK_Lop4QE1vwb4bYU
+APP_KEY=
 
 DB_HOST=127.0.0.1
 DB_NAME=yii2_starter

CHANGELOG.md

@@ -3,6 +3,11 @@ CHANGELOG for Yii2 STARTER PROJECT TEMPLATE
 
 *should be replaced with real project changelog later*
 
+Develop
+---------------------
+* Added APP_KEY hash generator console command.
+* Base module has been removed 
+
 v0.9.6
 ---------------------
 * Fix register page, controller missed use statement for RegisterForm.

README.md

@@ -99,7 +99,11 @@ APP_DEBUG=true
 APP_KEY=wUZvVVKJyHFGDB9qK_Lop4QE1vwb4bYU
 ```
 
-*`APP_KEY` is used as cookie verification key. Unfortunately there are no post install composer script to generate it automatically*
+*`APP_KEY` is used as CSRF token (cookie verification key). In order to set or change it, run:
+ 
+```bash
+php yii security/app-key
+```
 
 ### Database
 

app/console/Controller.php

@@ -2,7 +2,7 @@
 
 namespace app\console;
 
-
+use yii\console\ExitCode;
 use yii\helpers\Console;
 
 abstract class Controller extends \yii\console\Controller
@@ -34,22 +34,25 @@ protected function line($string = '')
 	 * Prints a yellow line to STDOUT.
 	 *
 	 * @param string $string the string to print
-	 * @return int|bool Number of bytes printed or false on error
+	 * @return int Exit code status
 	 */
 	protected function warning($string)
 	{
-		return $this->line($string, Console::FG_YELLOW);
+		$this->line($string, Console::FG_YELLOW);
+
+		return ExitCode::TEMPFAIL;
 	}
 
 	/**
 	 * Prints a yellow line to STDOUT.
 	 *
 	 * @param string $string the string to print
-	 * @return int|bool Number of bytes printed or false on error
+	 * @return int Exit code status
 	 */
 	protected function success($string)
 	{
-		return $this->line($string, Console::FG_GREEN);
-	}
+		$this->line($string, Console::FG_GREEN);
 
-}
+		return ExitCode::OK;
+	}
+}

app/console/SecurityController.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace app\console;
+
+use Yii;
+use yii\base\Exception;
+
+/**
+ * Class GenerateController
+ *
+ * @package app\console\controllers
+ */
+class SecurityController extends Controller
+{
+	/**
+	 * Action Generate
+	 *
+	 * @return bool|int
+	 * @throws Exception
+	 */
+	public function actionAppKey()
+	{
+		$key = Yii::$app->security->generateRandomString();
+		$envPath = Yii::getAlias('@srcPath/.env');
+
+		if (file_exists($envPath)) {
+			$envData = file_get_contents($envPath);
+
+			if (! preg_match('/APP_KEY=(\w+)?/', $envData)) {
+				return $this->warning('No APP_KEY has been found in your .env file');
+			}
+
+			$updatedEnvData = preg_replace('/APP_KEY=(\w+)?/', "APP_KEY={$key}", $envData);
+			if (! $updatedEnvData) {
+				return $this->stderr('Error during the app key setup');
+			}
+
+			file_put_contents($envPath, $updatedEnvData);
+
+			return $this->success('The application key has been successfully set');
+		}
+
+		return $this->warning('The .env file not found. Do you need to create one?');
+	}
+}

app/modules/admin/forms/UserForm.php

@@ -29,7 +29,7 @@ class UserForm extends User
 	public function rules()
 	{
 		return array_merge(parent::rules(), [
-			['password', 'safe'],
+			[['password', 'passwordRepeat'], 'string'],
 			[
 				'passwordRepeat',
 				'required',
@@ -53,11 +53,19 @@ public function beforeSave($insert)
 			$this->setPassword($this->password);
 		}
 
-		$this->updateUserRoles($this->roles);
-		
 		return parent::beforeSave($insert);
 	}
-	
+
+	/**
+	 * @inheritDoc
+	 */
+	public function afterSave($insert, $changedAttributes)
+	{
+		parent::afterSave($insert, $changedAttributes);
+
+		$this->updateUserRoles($this->roles);
+	}
+
 	/**
 	 * @inheritdoc
 	 */

app/modules/base/console/MigrateController.php

@@ -1,14 +1,14 @@
 <?php
-namespace app\modules\base\db;
+namespace app\traits\migrations;
 
-class Migration extends \yii\db\Migration
+trait CreateTableOptions
 {
 	/**
 	 * Prepare table options based on DB driver
 	 *
 	 * @return null|string
 	 */
-	protected function tableOptions()
+	protected function createTableOptions()
 	{
 		$tableOptions = null;
 		if ($this->db->driverName === 'mysql') {

app/modules/base/db/Migration.php …traits/migrations/CreateTableOptions.phpapp/modules/base/db/Migration.php renamed to app/traits/migrations/CreateTableOptions.php app/modules/base/db/Migration.php renamed to app/traits/migrations/CreateTableOptions.php

@@ -8,7 +8,7 @@
   "prefer-stable": true,
   "require": {
     "php": ">=7.0",
-    "yiisoft/yii2": "~2.0.12",
+    "yiisoft/yii2": "~2.0.22",
     "yiisoft/yii2-bootstrap": "~2.0.0",
     "yiisoft/yii2-swiftmailer": "~2.0.0",
     "yiisoft/yii2-faker": "~2.0.0",
@@ -51,12 +51,12 @@
       "yii\\composer\\Installer::postInstall",
       "@php tests/_phpstorm.php"
     ],
-    "post-update-cmd": [
-      "@php tests/_phpstorm.php"
-    ],
     "post-create-project-cmd": [
       "yii\\composer\\Installer::postCreateProject",
-      "yii\\composer\\Installer::postInstall"
+      "yii\\composer\\Installer::postInstall",
+      "cp -n .env.example .env",
+      "cp -n public/.htaccess.example public/.htaccess",
+      "php yii security/app-key"
     ]
   },
   "extra": {

composer.json

@@ -1,27 +1,36 @@
 <?php
 
-\Yii::setAlias('@app', dirname(__DIR__) . '/app');
-\Yii::setAlias('@webroot', dirname(__DIR__) . '/public');
+\Yii::setAlias('@srcPath', dirname(__DIR__));
+\Yii::setAlias('@app', '@srcPath/app');
+\Yii::setAlias('@webroot', '@srcPath/public');
 
 $db       = require __DIR__ . '/db.php';
 $settings = require __DIR__ . '/settings.php';
 
 $config = [
-	'id'                  => 'main-console',
-	'basePath'   => dirname(__DIR__) . '/app',
-	'runtimePath'   => dirname(__DIR__) . '/runtime',
-	'vendorPath'   => dirname(__DIR__) . '/vendor',
+	'id'         => 'main-console',
+	'basePath'   => '@app',
+	'runtimePath'   => '@srcPath/runtime',
+	'vendorPath'   => '@srcPath/vendor',
 	'controllerNamespace' => 'app\\console',
 	'bootstrap'  => ['log', 'settings'],
 	'aliases'    => [
-		'@config'=> dirname(__DIR__) . '/config',
-		'@migrations' => dirname(__DIR__) . '/database/migrations',
-		'@fixtures' => dirname(__DIR__) . '/database/fixtures',
+		'@config'=> '@srcPath/config',
+		'@migrations' => '@srcPath/database/migrations',
+		'@fixtures' => '@srcPath/database/fixtures',
 		'@app/fixtures' => '@fixtures',
 	],
 	'controllerMap' => [
 		'migrate' => [
-			'class' => \app\modules\base\console\MigrateController::class,
+			'class' => \yii\console\controllers\MigrateController::class,
+			'templateFile' => '@migrations/templates/migration.php',
+			'generatorTemplateFiles' => [
+				'create_table' => '@migrations/templates/createTableMigration.php',
+				'drop_table' => '@migrations/templates/dropTableMigration.php',
+				'add_column' => '@migrations/templates/addColumnMigration.php',
+				'drop_column' => '@migrations/templates/dropColumnMigration.php',
+				'create_junction' => '@migrations/templates/createTableMigration.php',
+			],
 			'migrationPath' => [
 				'@migrations',
 				'@yii/rbac/migrations',