feat: update dependencies, add linting, fix codebase, cleanup (#11)

* chore(deps): update dependencies

* feat(tests): add matrix testing, problem matcher

* feat(lint): add php-cs-fixer, fix codebase

.editorconfig

@@ -0,0 +1,16 @@
+# EditorConfig is awesome: https://editorconfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = space
+indent_size = 4
+max_line_length = 100
+
+[*.yml]
+indent_size = 2
+

.github/workflows/auto-approve.yml

@@ -0,0 +1,12 @@
+name: Auto Approve Dependabot
+
+on: pull_request_target
+
+jobs:
+  auto-approve:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: hmarr/auto-approve-action@v2.0.0
+      if: github.actor == 'dependabot[bot]' || github.actor == 'dependabot-preview[bot]'
+      with:
+        github-token: "${{ secrets.GITHUB_TOKEN }}"

.github/workflows/phpunit.yml

@@ -0,0 +1,45 @@
+name: PHPUnit
+
+on: [push]
+
+jobs:
+  build-test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        php_version:
+          - 7.4
+          - 8.0 
+          - 8.1
+          - 8.2
+          - 8.3
+          - latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php_version }}
+          tools: composer, phpunit
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+      - name: Cache Composer dependencies
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-${{ matrix.php_version }}-${{ hashFiles('**/composer.json') }}
+
+      - name: Install Dependencies
+        run: composer install -q --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
+
+      - name: Configure matchers
+        uses: mheap/phpunit-matcher-action@v1
+
+      - name: Run tests
+        run: composer test-ci
+ 

.gitignore

@@ -0,0 +1,2 @@
+vendor
+composer.lock

.php-cs-fixer.dist.php

@@ -0,0 +1,15 @@
+<?php
+
+$finder = (new PhpCsFixer\Finder())
+    ->in(__DIR__);
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@PhpCsFixer' => true,
+        '@PHP74Migration' => true,
+        '@PSR12' => true,
+        'strict_param' => true,
+        'array_syntax' => ['syntax' => 'short'],
+    ])
+    ->setFinder($finder)
+;

CHANGELOG.md

@@ -4,6 +4,26 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## 0.0.1 - 2017-02-07
+## [1.2.0](https://github.com/superhelio/commands/tree/1.2.0) (2017-10-19)
-### Added
+- Bumped PHP version requirement to >=7.0, PHP5.6 was taking really long time to resolve
-- `superhelio:reload`
+- Included composer.lock, which is generated with PHP v7.0.23
+
+## [1.1.2](https://github.com/superhelio/commands/tree/1.1.2) (2017-09-15)
+- Removed composer.lock, only to enable correct CI builds
+- Reworked travis-ci.org configuration, builds should now go green
+
+## [1.1.1](https://github.com/superhelio/commands/tree/1.1.1) (2017-08-27)
+- Typo fixes
+- Removal of dead/unnecessary code
+- Added composer.lock for faster builds
+
+## [1.1.0](https://github.com/superhelio/commands/tree/1.1.0) (2017-08-27)
+- New command: `superhelio:gozer` with tests
+
+## [1.0.0](https://github.com/superhelio/commands/tree/1.0.0) (2017-02-08)
+- Fixed Scrutinizer reported issue
+- Renamed LICENSE
+- Tested `github_changelog_generator`, but did not like it
+
+## [0.0.1](https://github.com/superhelio/commands/tree/0.0.1) (2017-02-07)
+- `superhelio:reload`

README.md

@@ -1,20 +1,19 @@
-# Laravel Commands by [SuperHelio](link-author)
+# Laravel Commands by [SuperHelio][link-author]
 
 [![Latest Version on Packagist][ico-version]][link-packagist]
 [![Software License][ico-license]](LICENSE.md)
-[![Build Status][ico-travis]][link-travis]
-[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
-[![Quality Score][ico-code-quality]][link-code-quality]
 [![Total Downloads][ico-downloads]][link-downloads]
 
 This is a collection of Laravel Artisan commands created to help everyone
 in their development work. We try to keep these as useful as possible.
 
+This package requires PHP 7.3 or later. The `composer.lock` file has been generated with PHP v7.4.13.
+
 ## Install
 
 ### Step 1: Install Through Composer
 
-``` bash
+```bash
 $ composer require superhelio/commands --dev
 ```
 
@@ -25,7 +24,7 @@ You'll only want to use these generators for local development, so you don't wan
 ```php
 public function register()
 {
-    if ($this->app->environment() == 'local') {
+    if ($this->app->environment() === 'local') {
         $this->app->register('SuperHelio\Commands\ServiceProvider');
     }
 }
@@ -33,9 +32,12 @@ public function register()
 
 ## Usage
 
-- *superhelio:reload*
+- _superhelio:gozer_
-    - Reset database, migrate and seed
+  - Force delete database tables that have your table prefix
-    - `php artisan superhelio:reload`
+  - `php artisan superhelio:gozer`
+- _superhelio:reload_
+  - Reset database, migrate and seed
+  - `php artisan superhelio:reload`
 
 ## Change log
 
@@ -43,14 +45,10 @@ Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recen
 
 ## Testing
 
-``` bash
+```bash
 $ composer test
 ```
 
-## Contributing
-
-Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
-
 ## Security
 
 If you discover any security related issues, please contact [SuperHelio](link-author).
@@ -66,15 +64,9 @@ The MIT License (MIT). Please see [License File](LICENSE.md) for more informatio
 
 [ico-version]: https://img.shields.io/packagist/v/superhelio/commands.svg?style=flat-square
 [ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
-[ico-travis]: https://img.shields.io/travis/superhelio/commands/master.svg?style=flat-square
-[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/superhelio/commands.svg?style=flat-square
-[ico-code-quality]: https://img.shields.io/scrutinizer/g/superhelio/commands.svg?style=flat-square
 [ico-downloads]: https://img.shields.io/packagist/dt/superhelio/commands.svg?style=flat-square
-
 [link-packagist]: https://packagist.org/packages/superhelio/commands
-[link-travis]: https://travis-ci.org/superhelio/commands
-[link-scrutinizer]: https://scrutinizer-ci.com/g/superhelio/commands/code-structure
-[link-code-quality]: https://scrutinizer-ci.com/g/superhelio/commands
 [link-downloads]: https://packagist.org/packages/superhelio/commands
 [link-author]: https://github.com/superhelio
-[link-contributors]: ../../contributors
+[link-contributors]: https://github.com/superhelio/commands/graphs/contributors
+[link-dbal]: https://packagist.org/packages/doctrine/dbal

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "superhelio/commands",
-    "description": "Laravel Commands",
+    "description": "This is a collection of Laravel Artisan commands created to help everyone in their development work.",
     "keywords": [
         "laravel",
         "superhelio",
@@ -17,11 +17,15 @@
         }
     ],
     "require": {
-        "php" : ">=5.5.0",
+        "php": "^7.4|^8",
-        "illuminate/support": "~5.2"
+        "illuminate/support": "^5.3|^6|^7|^8|^9|^10|^11",
+        "doctrine/dbal": "^2.5|^2.6|^3"
     },
     "require-dev": {
-        "phpunit/phpunit" : "4.*"
+        "roave/security-advisories": "dev-master",
+        "phpunit/phpunit": "^8.0",
+        "orchestra/testbench": "^3.3|^4|^5|^6|^7|^8",
+        "friendsofphp/php-cs-fixer": "^3.9"
     },
     "autoload": {
         "psr-4": {
@@ -30,11 +34,13 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "Superhelio\\Commands\\Test\\": "tests"
+            "Superhelio\\Commands\\Tests\\": "tests"
         }
     },
     "scripts": {
-        "test": "phpunit"
+        "lint": "PHP_CS_FIXER_IGNORE_ENV=1 php-cs-fixer fix --diff --allow-risky=yes",
+        "test": "phpunit",
+        "test-ci": "phpunit --teamcity"
     },
     "extra": {
         "branch-alias": {

phpcs.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0"?>
+<ruleset name="Project"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/master/phpcs.xsd">
+    <description>Project PHP Code Style Rules</description>
+
+    <file>src</file>
+    <file>tests</file>
+
+    <arg name="basepath" value="."/>
+    <arg name="colors"/>
+    <arg name="parallel" value="75"/>
+    <arg value="np"/>
+
+    <exclude-pattern>*/.git/*</exclude-pattern>
+    <exclude-pattern>*/vendor/*</exclude-pattern>
+
+    <rule ref="PSR2" />
+</ruleset>

phpunit.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false">
+
+    <testsuites>
+        <testsuite name="Superhelio\Commands Test Suite">
+            <directory suffix="Test.php">./tests/</directory>
+        </testsuite>
+    </testsuites>
+    <php>
+        <env name="APP_ENV" value="testing"/>
+    </php>
+
+    <filter>
+        <whitelist addUncoveredFilesFromWhitelist="false">
+            <directory suffix=".php">src/</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/Commands/Gozer.php

@@ -0,0 +1,184 @@
+<?php
+
+namespace Superhelio\Commands\Commands;
+
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Support\Str;
+
+class Gozer extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'superhelio:gozer';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Force delete database tables that have your table prefix';
+
+    /**
+     * @var string Database table prefix
+     */
+    private $dbPrefix = '';
+
+    /**
+     * Execute the console command.
+     *
+     * @return bool
+     */
+    public function handle()
+    {
+        if (!class_exists('\\Doctrine\\DBAL\\Schema\\Schema')) {
+            $this->error('You are missing doctrine/dbal, you should add it to your project:');
+            $this->info('composer require doctrine/dbal');
+
+            return false;
+        }
+
+        $this->info('
+
+  ________
+ /  _____/  ____________ ___________ 
+/   \  ___ /  _ \___   // __ \_  __ \
+\    \_\  (  <_> )    /\  ___/|  | \/
+ \______  /\____/_____ \\___  >__|
+        \/            \/    \/
+
+');
+
+        $this->setDatabasePrefix($this->getDatabasePrefix());
+
+        $confirmationQuestion = 'Delete all of your database tables?';
+        if (!empty($this->dbPrefix)) {
+            $confirmationQuestion = sprintf(
+                'Delete your tables that begin with %s*',
+                $this->dbPrefix
+            );
+        }
+
+        if ($this->confirm($confirmationQuestion)) {
+            $connection = $this->getConnection();
+            $tables = $this->getTables($connection);
+
+            /**
+             * Reject tables that do not have specified table prefix.
+             * We would not want to destroy other tables that might
+             * be in the same database, in "homestead" for example.
+             *
+             * @var \Illuminate\Support\Collection $tables
+             */
+            $tables = $this->getFilteredTables($tables);
+
+            // Check that we got at least one table, bail out if not
+            if ($tables->count() < 1) {
+                $this->info('There are no tables, only Zuul.');
+
+                return true;
+            }
+
+            /*
+             * Bid your farewells to these tables.
+             * Last look and confirmation.
+             */
+            $this->info(sprintf(
+                "Tables found:\n - %s",
+                implode(",\n - ", $tables->toArray())
+            ));
+            $this->line('');
+
+            // Last confirmation before dropping tables
+            if ($this->confirm('Really delete those tables?')) {
+                /** Fancy pants progress bar to see your tables get destroyed */
+                $bar = $this->output->createProgressBar($tables->count());
+
+                Schema::disableForeignKeyConstraints();
+                $tables->each(function ($table) use ($bar, $connection) {
+                    // Drop the table
+                    $connection->dropTable($table);
+
+                    // Advance our progress bar
+                    $bar->advance();
+                });
+                Schema::enableForeignKeyConstraints();
+
+                // Progress bar is now finished
+                $bar->finish();
+            }
+
+            $this->line('');
+            $this->line('');
+        }
+
+        $this->info('Done.');
+
+        return true;
+    }
+
+    /**
+     * @return bool|\Doctrine\DBAL\Schema\AbstractSchemaManager
+     */
+    public function getConnection()
+    {
+        try {
+            // @var \Doctrine\DBAL\Schema\AbstractSchemaManager $connection
+            return app('db')->connection()->getDoctrineSchemaManager();
+        } catch (\Exception $e) {
+            $this->error($e->getMessage());
+
+            return false;
+        }
+    }
+
+    /**
+     * @return array|bool
+     */
+    public function getTables(\Doctrine\DBAL\Schema\AbstractSchemaManager $connection)
+    {
+        try {
+            /** @var array $tables */
+            $tables = $connection->listTableNames();
+        } catch (\Exception $e) {
+            $this->error($e->getMessage());
+
+            return false;
+        }
+
+        return $tables;
+    }
+
+    public function getDatabasePrefix()
+    {
+        return trim(DB::connection()->getTablePrefix());
+    }
+
+    /**
+     * This is mainly for testing purposes.
+     *
+     * @param string $prefix
+     */
+    public function setDatabasePrefix($prefix = '')
+    {
+        $this->dbPrefix = $prefix;
+    }
+
+    /**
+     * @param array|\Illuminate\Support\Collection $tables
+     *
+     * @return \Illuminate\Support\Collection
+     */
+    public function getFilteredTables($tables = [])
+    {
+        $prefix = $this->dbPrefix;
+
+        return collect($tables)->reject(function ($table) use ($prefix) {
+            return !Str::startsWith($table, $prefix);
+        });
+    }
+}

src/Commands/Reload.php

@@ -18,17 +18,7 @@ class Reload extends Command
      *
      * @var string
      */
-    protected $description = 'Delete database tables, migrate and run seeds';
+    protected $description = 'Rollback migrations, migrate and run seeds';
-
-    /**
-     * Create a new command instance.
-     *
-     * @return void
-     */
-    public function __construct()
-    {
-        parent::__construct();
-    }
 
     /**
      * Execute the console command.
@@ -43,7 +33,7 @@ class Reload extends Command
                 [
                     '--no-interaction' => true,
                     '--env' => 'development',
-                    '--verbose' => 3
+                    '--verbose' => 3,
                 ]
             );
             $this->call(
@@ -52,9 +42,13 @@ class Reload extends Command
                     '--seed' => true,
                     '--no-interaction' => true,
                     '--env' => 'development',
-                    '--verbose' => 3
+                    '--verbose' => 3,
                 ]
             );
+
+            return true;
         }
+
+        return false;
     }
 }

src/Facade.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace Superhelio\Commands;
 
 class Facade extends \Illuminate\Support\Facades\Facade

src/ServiceProvider.php

@@ -5,9 +5,8 @@ namespace Superhelio\Commands;
 use Illuminate\Support\ServiceProvider as BaseServiceProvider;
 
 /**
- * Class PackageServiceProvider
+ * Class PackageServiceProvider.
  *
- * @package Superhelio\Commands
  * @see http://laravel.com/docs/master/packages#service-providers
  * @see http://laravel.com/docs/master/providers
  */
@@ -17,6 +16,7 @@ class ServiceProvider extends BaseServiceProvider
      * Indicates if loading of the provider is deferred.
      *
      * @see http://laravel.com/docs/master/providers#deferred-providers
+     *
      * @var bool
      */
     protected $defer = false;
@@ -25,18 +25,26 @@ class ServiceProvider extends BaseServiceProvider
      * Register the service provider.
      *
      * @see http://laravel.com/docs/master/providers#the-register-method
-     * @return void
      */
     public function register()
     {
         $this->registerReloader();
+        $this->registerGozer();
     }
 
     private function registerReloader()
     {
         $this->app->singleton('command.superhelio.reload', function ($app) {
-            return $app['Superhelio\Commands\Commands\Reload'];
+            return $app[\Superhelio\Commands\Commands\Reload::class];
         });
         $this->commands('command.superhelio.reload');
     }
+
+    private function registerGozer()
+    {
+        $this->app->singleton('command.superhelio.gozer', function ($app) {
+            return $app[\Superhelio\Commands\Commands\Gozer::class];
+        });
+        $this->commands('command.superhelio.gozer');
+    }
 }

tests/GozerTest.php

@@ -0,0 +1,134 @@
+<?php
+
+namespace Superhelio\Commands\Tests;
+
+use ReflectionClass;
+use Superhelio\Commands\Commands\Gozer;
+use Illuminate\Support\Facades\Hash;
+use Illuminate\Support\Facades\DB;
+
+/**
+ * @internal
+ * @coversNothing
+ */
+class GozerTest extends \Orchestra\Testbench\TestCase
+{
+    /**
+     * Setup the test environment.
+     */
+    public function setUp(): void
+    {
+        parent::setUp();
+        $this->artisan('migrate', ['--database' => 'testbench']);
+    }
+
+    /**
+     * Define environment setup.
+     *
+     * @param \Illuminate\Foundation\Application $app
+     */
+    protected function getEnvironmentSetUp($app)
+    {
+        // Setup default database to use sqlite :memory:
+        $app['config']->set('database.default', 'testbench');
+        $app['config']->set('database.connections.testbench', [
+            'driver' => 'sqlite',
+            'database' => ':memory:',
+            'prefix' => 'gozerTest__',
+        ]);
+    }
+
+    /**
+     * Get package providers.
+     * At a minimum this is the package being tested, but also
+     * would include packages upon which our package depends.
+     * In a normal app environment these would be added to
+     * the 'providers' array in the config/app.php file.
+     *
+     * @param \Illuminate\Foundation\Application $app
+     *
+     * @return array
+     */
+    protected function getPackageProviders($app)
+    {
+        return [
+            \Superhelio\Commands\Tests\Stubs\ServiceProvider::class,
+            \Superhelio\Commands\ServiceProvider::class,
+        ];
+    }
+
+    public function testDatabaseIsThereAndFunctions()
+    {
+        DB::table('users')->insert([
+            'name' => 'User name',
+            'email' => 'hello@gozer.dev',
+            'password' => bcrypt('123'),
+        ]);
+
+        $users = DB::table('users')->where('id', '=', 1)->first();
+        self::assertEquals('hello@gozer.dev', $users->email);
+        self::assertEquals('User name', $users->name);
+        self::assertTrue(Hash::check('123', $users->password));
+    }
+
+    public function testDbalIsInstalled()
+    {
+        self::assertTrue(class_exists('\\Doctrine\\DBAL\\Schema\\Schema'));
+    }
+
+    public function testGozerIsInstalled()
+    {
+        self::assertTrue(class_exists('\\Superhelio\\Commands\\Commands\\Gozer'));
+    }
+
+    public function testGozerHasRequiredMethodsAndProperties()
+    {
+        $gozer = new ReflectionClass('\\Superhelio\\Commands\\Commands\\Gozer');
+        self::assertTrue($gozer->hasMethod('handle'));
+        self::assertTrue($gozer->hasProperty('signature'));
+        self::assertTrue($gozer->hasProperty('description'));
+        self::assertTrue($gozer->hasProperty('dbPrefix'));
+    }
+
+    public function testGozerFindsDatabasePrefix()
+    {
+        $gozer = new Gozer();
+
+        self::assertEquals('gozerTest__', $gozer->getDatabasePrefix());
+    }
+
+    public function testGozerFindsUsersTable()
+    {
+        $gozer = new Gozer();
+
+        $connection = $gozer->getConnection();
+
+        $tables = $gozer->getTables($connection);
+        self::assertContains('gozerTest__users', $tables);
+
+        $gozer->setDatabasePrefix('gozerTest__');
+        $filteredTables = $gozer->getFilteredTables($tables);
+        self::assertTrue(is_a($filteredTables, \Illuminate\Support\Collection::class));
+        self::assertContains('gozerTest__users', $filteredTables->toArray());
+    }
+
+    public function testGozerTableFilteringWorks()
+    {
+        $gozer = new Gozer();
+        $tables = [
+            'gozerTest__users',
+            'gozerTest__migrations',
+            'this_should_be_filtered',
+            'filter_me_too',
+        ];
+
+        $gozer->setDatabasePrefix('gozerTest__');
+        $filtered = $gozer->getFilteredTables($tables);
+        $array = $filtered->toArray();
+
+        self::assertNotContains('this_should_be_filtered', $array);
+        self::assertNotContains('filter_me_too', $array);
+        self::assertContains('gozerTest__users', $array);
+        self::assertContains('gozerTest__migrations', $array);
+    }
+}

tests/ReloadTest.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Superhelio\Commands\Tests;
+
+/**
+ * @internal
+ * @coversNothing
+ */
+class ReloadTest extends \Orchestra\Testbench\TestCase
+{
+    public function testReloadTest()
+    {
+        self::assertTrue(true);
+    }
+
+    public function testReloadIsInstalled()
+    {
+        self::assertTrue(class_exists('\\Superhelio\\Commands\\Commands\\Reload'));
+    }
+
+    public function testReloadHasRequiredMethodsAndProperties()
+    {
+        $reload = new \ReflectionClass('\\Superhelio\\Commands\\Commands\\Reload');
+        self::assertTrue($reload->hasMethod('handle'));
+        self::assertTrue($reload->hasProperty('signature'));
+        self::assertTrue($reload->hasProperty('description'));
+    }
+}

tests/Stubs/ServiceProvider.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Superhelio\Commands\Tests\Stubs;
+
+class ServiceProvider extends \Illuminate\Support\ServiceProvider
+{
+    public function boot()
+    {
+        $this->loadMigrationsFrom(dirname(__DIR__).'/migrations');
+    }
+}

tests/migrations/2014_10_12_000000_create_users_table.php

@@ -0,0 +1,31 @@
+<?php
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Migrations\Migration;
+
+class CreateUsersTable extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up()
+    {
+        Schema::create('users', function (Blueprint $table) {
+            $table->increments('id');
+            $table->string('name');
+            $table->string('email')->unique();
+            $table->string('password');
+            $table->rememberToken();
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down()
+    {
+        Schema::dropIfExists('users');
+    }
+}