Skip to content

Commit

Permalink
feat(lint): add php-cs-fixer, fix codebase
Browse files Browse the repository at this point in the history
  • Loading branch information
ivuorinen committed Nov 8, 2024
1 parent 5720e1e commit e3a81b4
Show file tree
Hide file tree
Showing 12 changed files with 77 additions and 90 deletions.
16 changes: 16 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -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

15 changes: 15 additions & 0 deletions .php-cs-fixer.dist.php
Original file line number Diff line number Diff line change
@@ -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)
;
24 changes: 0 additions & 24 deletions .travis.yml

This file was deleted.

26 changes: 8 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@

[![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
Expand All @@ -16,7 +13,7 @@ This package requires PHP 7.3 or later. The `composer.lock` file has been genera

### Step 1: Install Through Composer

``` bash
```bash
$ composer require superhelio/commands --dev
```

Expand All @@ -35,20 +32,20 @@ public function register()

## Usage

- *superhelio:gozer*
- Force delete database tables that have your table prefix
- `php artisan superhelio:gozer`
- *superhelio:reload*
- Reset database, migrate and seed
- `php artisan superhelio:reload`
- _superhelio:gozer_
- Force delete database tables that have your table prefix
- `php artisan superhelio:gozer`
- _superhelio:reload_
- Reset database, migrate and seed
- `php artisan superhelio:reload`

## Change log

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Testing

``` bash
```bash
$ composer test
```

Expand All @@ -67,15 +64,8 @@ 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]: https://github.com/superhelio/commands/graphs/contributors
Expand Down
4 changes: 3 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@
"require-dev": {
"roave/security-advisories": "dev-master",
"phpunit/phpunit": "^8.0",
"orchestra/testbench": "^3.3|^4|^5|^6|^7|^8"
"orchestra/testbench": "^3.3|^4|^5|^6|^7|^8",
"friendsofphp/php-cs-fixer": "^3.9"
},
"autoload": {
"psr-4": {
Expand All @@ -37,6 +38,7 @@
}
},
"scripts": {
"lint": "PHP_CS_FIXER_IGNORE_ENV=1 php-cs-fixer fix --diff --allow-risky=yes",
"test": "phpunit",
"test-ci": "phpunit --teamcity"
},
Expand Down
25 changes: 8 additions & 17 deletions src/Commands/Gozer.php
Original file line number Diff line number Diff line change
Expand Up @@ -76,16 +76,14 @@ public function handle()
*/
$tables = $this->getFilteredTables($tables);

/**
* Check that we got at least one table, bail out if not
*/
// 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.
*/
Expand All @@ -95,27 +93,22 @@ public function handle()
));
$this->line('');

/**
* Last confirmation before dropping tables
*/
// 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 */
// Drop the table
$connection->dropTable($table);

/** Advance our progress bar */
// Advance our progress bar
$bar->advance();

});
Schema::enableForeignKeyConstraints();

/** Progress bar is now finished */
// Progress bar is now finished
$bar->finish();
}

Expand All @@ -134,7 +127,7 @@ public function handle()
public function getConnection()
{
try {
/** @var \Doctrine\DBAL\Schema\AbstractSchemaManager $connection */
// @var \Doctrine\DBAL\Schema\AbstractSchemaManager $connection
return app('db')->connection()->getDoctrineSchemaManager();
} catch (\Exception $e) {
$this->error($e->getMessage());
Expand All @@ -144,8 +137,6 @@ public function getConnection()
}

/**
* @param \Doctrine\DBAL\Schema\AbstractSchemaManager $connection
*
* @return array|bool
*/
public function getTables(\Doctrine\DBAL\Schema\AbstractSchemaManager $connection)
Expand All @@ -168,7 +159,7 @@ public function getDatabasePrefix()
}

/**
* This is mainly for testing purposes
* This is mainly for testing purposes.
*
* @param string $prefix
*/
Expand Down
4 changes: 2 additions & 2 deletions src/Commands/Reload.php
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public function handle()
[
'--no-interaction' => true,
'--env' => 'development',
'--verbose' => 3
'--verbose' => 3,
]
);
$this->call(
Expand All @@ -42,7 +42,7 @@ public function handle()
'--seed' => true,
'--no-interaction' => true,
'--env' => 'development',
'--verbose' => 3
'--verbose' => 3,
]
);

Expand Down
5 changes: 2 additions & 3 deletions src/ServiceProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@
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
*/
Expand All @@ -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;
Expand All @@ -25,7 +25,6 @@ class ServiceProvider extends BaseServiceProvider
* Register the service provider.
*
* @see http://laravel.com/docs/master/providers#the-register-method
* @return void
*/
public function register()
{
Expand Down
30 changes: 16 additions & 14 deletions tests/GozerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@
use Illuminate\Support\Facades\Hash;
use Illuminate\Support\Facades\DB;

/**
* @internal
* @coversNothing
*/
class GozerTest extends \Orchestra\Testbench\TestCase
{
/**
Expand All @@ -22,8 +26,6 @@ public function setUp(): void
* Define environment setup.
*
* @param \Illuminate\Foundation\Application $app
*
* @return void
*/
protected function getEnvironmentSetUp($app)
{
Expand Down Expand Up @@ -51,16 +53,16 @@ protected function getPackageProviders($app)
{
return [
\Superhelio\Commands\Tests\Stubs\ServiceProvider::class,
\Superhelio\Commands\ServiceProvider::class
\Superhelio\Commands\ServiceProvider::class,
];
}

public function test_database_is_there_and_functions()
public function testDatabaseIsThereAndFunctions()
{
DB::table('users')->insert([
'name' => 'User name',
'email' => 'hello@gozer.dev',
'password' => bcrypt('123')
'password' => bcrypt('123'),
]);

$users = DB::table('users')->where('id', '=', 1)->first();
Expand All @@ -69,17 +71,17 @@ public function test_database_is_there_and_functions()
self::assertTrue(Hash::check('123', $users->password));
}

public function test_dbal_is_installed()
public function testDbalIsInstalled()
{
self::assertTrue(class_exists('\\Doctrine\\DBAL\\Schema\\Schema'));
}

public function test_gozer_is_installed()
public function testGozerIsInstalled()
{
self::assertTrue(class_exists('\\Superhelio\\Commands\\Commands\\Gozer'));
}

public function test_gozer_has_required_methods_and_properties()
public function testGozerHasRequiredMethodsAndProperties()
{
$gozer = new ReflectionClass('\\Superhelio\\Commands\\Commands\\Gozer');
self::assertTrue($gozer->hasMethod('handle'));
Expand All @@ -88,14 +90,14 @@ public function test_gozer_has_required_methods_and_properties()
self::assertTrue($gozer->hasProperty('dbPrefix'));
}

public function test_gozer_finds_database_prefix()
public function testGozerFindsDatabasePrefix()
{
$gozer = new Gozer();

self::assertEquals('gozerTest__', $gozer->getDatabasePrefix());
}

public function test_gozer_finds_users_table()
public function testGozerFindsUsersTable()
{
$gozer = new Gozer();

Expand All @@ -110,15 +112,15 @@ public function test_gozer_finds_users_table()
self::assertContains('gozerTest__users', $filteredTables->toArray());
}

public function test_gozer_table_filtering_works()
public function testGozerTableFilteringWorks()
{
$gozer = new Gozer();
$tables = array(
$tables = [
'gozerTest__users',
'gozerTest__migrations',
'this_should_be_filtered',
'filter_me_too'
);
'filter_me_too',
];

$gozer->setDatabasePrefix('gozerTest__');
$filtered = $gozer->getFilteredTables($tables);
Expand Down
12 changes: 6 additions & 6 deletions tests/ReloadTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,23 @@

namespace Superhelio\Commands\Tests;

use Superhelio\Commands\Commands\Reload;
use Illuminate\Foundation\Testing\DatabaseMigrations;
use Illuminate\Foundation\Testing\DatabaseTransactions;

/**
* @internal
* @coversNothing
*/
class ReloadTest extends \Orchestra\Testbench\TestCase
{
public function testReloadTest()
{
self::assertTrue(true);
}

public function test_reload_is_installed()
public function testReloadIsInstalled()
{
self::assertTrue(class_exists('\\Superhelio\\Commands\\Commands\\Reload'));
}

public function test_reload_has_required_methods_and_properties()
public function testReloadHasRequiredMethodsAndProperties()
{
$reload = new \ReflectionClass('\\Superhelio\\Commands\\Commands\\Reload');
self::assertTrue($reload->hasMethod('handle'));
Expand Down
2 changes: 1 addition & 1 deletion tests/Stubs/ServiceProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ class ServiceProvider extends \Illuminate\Support\ServiceProvider
{
public function boot()
{
$this->loadMigrationsFrom(dirname(__DIR__) . '/migrations');
$this->loadMigrationsFrom(dirname(__DIR__).'/migrations');
}
}
Loading

0 comments on commit e3a81b4

Please sign in to comment.