Merge pull request #4 from melihovv/laravel-7-support

melihovv · web-flow · commit 4288ea728674 · 2020-03-06T02:45:07.000+04:00
Laravel 7 support
diff --git a/.coveralls.yml b/.coveralls.yml
diff --git a/.github/workflows/default.yml b/.github/workflows/default.yml
@@ -0,0 +1,43 @@
+name: Run tests
+
+on:
+  push:
+  schedule:
+    - cron: '0 0 * * *'
+
+jobs:
+  php-tests:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        php: [7.4, 7.3, 7.2]
+        laravel: [7.*, 6.*]
+        dependency-version: [prefer-lowest, prefer-stable]
+        os: [ubuntu-latest, windows-latest]
+        include:
+          - laravel: 7.*
+            testbench: 5.*
+          - laravel: 6.*
+            testbench: 4.*
+
+    name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.dependency-version }} - ${{ matrix.os }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v1
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v1
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick
+          coverage: none
+
+      - name: Install dependencies
+        run: |
+          composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
+          composer update --${{ matrix.dependency-version }} --prefer-dist --no-interaction --no-suggest
+
+      - name: Execute tests
+        run: composer run phpunit
diff --git a/.styleci.yml b/.styleci.yml
@@ -1,9 +1 @@
-preset: recommended
-enabled:
-  - concat_with_spaces
-disabled:
-  - align_double_arrow
-  - phpdoc_to_comment
-  - phpdoc_var_without_name
-  - concat_without_spaces
-  - no_multiline_whitespace_around_double_arrow
+preset: laravel
diff --git a/.travis.yml b/.travis.yml
diff --git a/README.md b/README.md
@@ -1,16 +1,15 @@
 Laravel Env Validator
 =====================
 
-[![Build Status](https://travis-ci.org/melihovv/laravel-env-validator.svg?branch=master)](https://travis-ci.org/melihovv/laravel-env-validator)
+![GitHub Workflow Status](https://img.shields.io/github/workflow/status/melihovv/laravel-env-validator/run-php-tests?label=Tests)
 [![styleci](https://styleci.io/repos/78041678/shield)](https://styleci.io/repos/78041678)
-[![Coverage Status](https://coveralls.io/repos/github/melihovv/laravel-env-validator/badge.svg?branch=master)](https://coveralls.io/github/melihovv/laravel-env-validator?branch=master)
 
 [![Packagist](https://img.shields.io/packagist/v/melihovv/laravel-env-validator.svg)](https://packagist.org/packages/melihovv/laravel-env-validator)
 [![Packagist](https://poser.pugx.org/melihovv/laravel-env-validator/d/total.svg)](https://packagist.org/packages/melihovv/laravel-env-validator)
 [![Packagist](https://img.shields.io/packagist/l/melihovv/laravel-env-validator.svg)](https://packagist.org/packages/melihovv/laravel-env-validator)
 
 Laravel Env Validator is meant to validate your .env file in order to avoid any
-unexpected behaviour for not having properly defined some variable or value. 
+unexpected behaviour for not having properly defined some variable or value.
 
 ### Highlights
 
@@ -33,13 +32,13 @@ php artisan vendor:publish --provider="Melihovv\LaravelEnvValidator\ServiceProvi
 
 ## Example configuration file
 ```php
-// config/laravel-env-validator.php
+// config/env-validator.php
 <?php
 
 return [
     'rules' => [
-        'SOME_IMPORTANT_VARIABLE' => 'required',
-        'ANOTHER_IMPORTANT_ONE'   => 'required|in:TYPE_A,TYPE_B,TYPE_C',
+        'APP_NAME' => 'required|string',
+        'APP_ENV'  => 'in:local,production',
     ],
 ];
 ```
diff --git a/composer.json b/composer.json
@@ -15,27 +15,29 @@
       "email": "amelihovv@ya.ru"
     }
   ],
+  "require": {
+    "php": ">=7.2",
+    "illuminate/config": "^6.0|^7.0",
+    "illuminate/console": "^6.0|^7.0",
+    "illuminate/support": "^6.0|^7.0",
+    "illuminate/validation": "^6.0|^7.0"
+  },
+  "require-dev": {
+    "orchestra/testbench": "^4.0|^5.0",
+    "phpunit/phpunit": "^8.4|^9.0"
+  },
   "autoload": {
     "psr-4": {
-      "Melihovv\\LaravelEnvValidator\\": "src/LaravelEnvValidator"
+      "Melihovv\\LaravelEnvValidator\\": "src"
     }
   },
   "autoload-dev": {
     "psr-4": {
       "Melihovv\\LaravelEnvValidator\\Tests\\": "tests/"
     }
   },
-  "require": {
-    "php": ">=7.2",
-    "illuminate/support": "^6.0",
-    "illuminate/validation": "^6.0"
-  },
-  "require-dev": {
-    "orchestra/testbench": "^4.0",
-    "phpunit/phpunit": "^8.0"
-  },
   "scripts": {
-    "phpunit": "phpunit --dont-report-useless-tests"
+    "phpunit": "phpunit"
   },
   "extra": {
     "laravel": {
diff --git a/config/env-validator.php b/config/env-validator.php
@@ -2,9 +2,11 @@
 
 return [
     'rules' => [
+        'APP_NAME' => 'required|string',
         'APP_ENV' => 'in:local,production',
-        'APP_KEY' => 'required',
+        'APP_KEY' => 'required|string',
         'APP_DEBUG' => 'boolean',
+        'APP_URL' => 'required|url',
 
         'DB_CONNECTION' => 'required',
         'DB_HOST' => 'required',
@@ -22,10 +24,10 @@
         'MAIL_FROM_NAME' => 'required',
 
         'BROADCAST_DRIVER' => 'nullable|in:pusher,redis,log,null',
-        'CACHE_DRIVER' => 'in:apc,array,database,file,memcached,redis',
-        'SESSION_DRIVER' => 'in:file,cookie,database,apc,memcached,redis,array',
-        'QUEUE_DRIVER' => 'in:sync,database,beanstalkd,sqs,redis,null',
-        'MAIL_DRIVER' => 'in:smtp,sendmail,mailgun,mandrill,ses,' .
-            'sparkpost,log,array',
+        'CACHE_DRIVER' => 'in:apc,array,database,file,memcached,redis,dynamodb',
+        'SESSION_DRIVER' => 'in:file,cookie,database,apc,memcached,redis,dynamodb,array',
+        'QUEUE_CONNECTION' => 'in:sync,database,beanstalkd,sqs,redis,null',
+        'LOG_CHANNEL' => 'in:single,daily,slack,syslog,errorlog,custom,stack,null,stderr,stdout',
+        'MAIL_DRIVER' => 'in:smtp,sendmail,mailgun,ses,postmark,log,array',
     ],
 ];
diff --git a/src/EnvValidationFailed.php b/src/EnvValidationFailed.php
@@ -0,0 +1,19 @@
+<?php
+
+namespace Melihovv\LaravelEnvValidator;
+
+use Exception;
+
+class EnvValidationFailed extends Exception
+{
+    public static function fromMessages(array $messages): self
+    {
+        $message = sprintf(
+            'The .env file has some problems. Please check config/env-validator.php%s%s',
+            PHP_EOL,
+            implode(PHP_EOL, $messages)
+        );
+
+        return new self($message);
+    }
+}
diff --git a/src/EnvValidator.php b/src/EnvValidator.php
@@ -19,16 +19,9 @@ public function __construct(Validator $validator)
     public function validate()
     {
         if ($this->validator->fails()) {
-            $messages = array_values(
-                $this->validator->messages()->all()
-            );
+            $messages = array_values($this->validator->messages()->all());
 
-            $message = 'The .env file has some problems.'
-                . ' Please check config/laravel-env-validator.php'
-                . PHP_EOL
-                . implode(PHP_EOL, $messages);
-
-            throw new Exception($message);
+            throw EnvValidationFailed::fromMessages($messages);
         }
     }
 }
diff --git a/src/EnvValidatorCommand.php b/src/EnvValidatorCommand.php
@@ -1,9 +1,8 @@
 <?php
 
-namespace Melihovv\LaravelEnvValidator\Console;
+namespace Melihovv\LaravelEnvValidator;
 
 use Illuminate\Console\Command;
-use Melihovv\LaravelEnvValidator\EnvValidatorFactory;
 
 class EnvValidatorCommand extends Command
 {
diff --git a/src/EnvValidatorFactory.php b/src/EnvValidatorFactory.php
@@ -8,7 +8,7 @@ class EnvValidatorFactory
 {
     public static function buildFromLaravelConfig()
     {
-        $config = config('laravel-env-validator.rules', []);
+        $config = config('env-validator.rules', []);
 
         $env = [];
         foreach (array_keys($config) as $variable) {
diff --git a/src/LaravelEnvValidator/Exception.php b/src/LaravelEnvValidator/Exception.php
diff --git a/src/ServiceProvider.php b/src/ServiceProvider.php
@@ -3,16 +3,15 @@
 namespace Melihovv\LaravelEnvValidator;
 
 use Illuminate\Support\ServiceProvider as Provider;
-use Melihovv\LaravelEnvValidator\Console\EnvValidatorCommand;
 
 class ServiceProvider extends Provider
 {
-    const CONFIG_PATH = __DIR__ . '/../config/laravel-env-validator.php';
+    const CONFIG_PATH = __DIR__.'/../config/env-validator.php';
 
     public function boot()
     {
         $this->publishes([
-            self::CONFIG_PATH => config_path('laravel-env-validator.php'),
+            self::CONFIG_PATH => config_path('env-validator.php'),
         ], 'config');
 
         if ($this->app->runningInConsole()) {
@@ -22,6 +21,6 @@ public function boot()
 
     public function register()
     {
-        $this->mergeConfigFrom(self::CONFIG_PATH, 'laravel-env-validator');
+        $this->mergeConfigFrom(self::CONFIG_PATH, 'env-validator');
     }
 }
diff --git a/tests/EnvValidatorCommandTest.php b/tests/EnvValidatorCommandTest.php
@@ -2,12 +2,12 @@
 
 namespace Melihovv\LaravelEnvValidator\Tests;
 
-use Melihovv\LaravelEnvValidator\EnvValidatorFactory;
-use Melihovv\LaravelEnvValidator\Exception;
+use Illuminate\Support\Facades\Config;
+use Melihovv\LaravelEnvValidator\EnvValidationFailed;
 use Melihovv\LaravelEnvValidator\ServiceProvider;
 use Orchestra\Testbench\TestCase;
 
-class LaravelEnvValidatorTest extends TestCase
+class EnvValidatorCommandTest extends TestCase
 {
     protected function getPackageProviders($app)
     {
@@ -21,13 +21,13 @@ public function it_has_the_right_error_message()
             putenv('VAR_1');
             putenv('VAR_2');
 
-            \Config::set('laravel-env-validator.rules', [
+            Config::set('env-validator.rules', [
                 'VAR_1' => 'required',
                 'VAR_2' => 'required',
             ]);
-            $envValidator = EnvValidatorFactory::buildFromLaravelConfig();
-            $envValidator->validate();
-        } catch (Exception $e) {
+
+            $this->artisan('config:env-validator');
+        } catch (EnvValidationFailed $e) {
             $this->assertStringContainsString(
                 'VAR_1',
                 $e->getMessage()
@@ -49,23 +49,22 @@ public function it_does_not_throw_exception_if_validation_is_met()
         putenv('VAR_1=123');
         putenv('VAR_2=A');
 
-        \Config::set('laravel-env-validator.rules', [
+        Config::set('env-validator.rules', [
             'VAR_1' => 'required',
             'VAR_2' => 'required|in:A,B,C',
         ]);
-        $envValidator = EnvValidatorFactory::buildFromLaravelConfig();
-        $envValidator->validate();
+
+        $this->artisan('config:env-validator');
 
         $this->assertTrue(true);
     }
 
     /** @test */
     public function it_doest_not_throw_exception_if_no_configuration_is_defined()
     {
-        \Config::set('laravel-env-validator.rules', []);
+        Config::set('env-validator.rules', []);
 
-        $envValidator = EnvValidatorFactory::buildFromLaravelConfig();
-        $envValidator->validate();
+        $this->artisan('config:env-validator');
 
         $this->assertTrue(true);
     }

Original file line number	Diff line number	Diff line change
`@@ -19,16 +19,9 @@ public function __construct(Validator $validator)`
`19`	`19`	`public function validate()`
`20`	`20`	`{`
`21`	`21`	`if ($this->validator->fails()) {`
`22`		`- $messages = array_values(`
`23`		`- $this->validator->messages()->all()`
`24`		`- );`
	`22`	`+ $messages = array_values($this->validator->messages()->all());`
`25`	`23`
`26`		`- $message = 'The .env file has some problems.'`
`27`		`- . ' Please check config/laravel-env-validator.php'`
`28`		`- . PHP_EOL`
`29`		`- . implode(PHP_EOL, $messages);`
`30`		`-`
`31`		`- throw new Exception($message);`
	`24`	`+ throw EnvValidationFailed::fromMessages($messages);`
`32`	`25`	`}`
`33`	`26`	`}`
`34`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,8 @@`
`1`	`1`	`<?php`
`2`	`2`
`3`		`-namespace Melihovv\LaravelEnvValidator\Console;`
	`3`	`+namespace Melihovv\LaravelEnvValidator;`
`4`	`4`
`5`	`5`	`use Illuminate\Console\Command;`
`6`		`-use Melihovv\LaravelEnvValidator\EnvValidatorFactory;`
`7`	`6`
`8`	`7`	`class EnvValidatorCommand extends Command`
`9`	`8`	`{`