From f2bf688fab4c9d08ead5368825940286a5bddcd9 Mon Sep 17 00:00:00 2001 From: Sean White Date: Sun, 14 Jun 2020 11:07:40 +0100 Subject: [PATCH] Initial public commit --- .editorconfig | 15 ++++ .gitattributes | 11 +++ .gitignore | 5 ++ .scrutinizer.yml | 19 +++++ .styleci.yml | 4 + .travis.yml | 21 +++++ CHANGELOG.md | 7 ++ CONTRIBUTING.md | 55 +++++++++++++ LICENSE.md | 21 +++++ README.md | 70 ++++++++++++++++ composer.json | 54 ++++++++++++ phpunit.xml.dist | 29 +++++++ src/Commands/SchemaTableCommand.php | 105 ++++++++++++++++++++++++ src/LaravelCliSchema.php | 8 ++ src/LaravelCliSchemaServiceProvider.php | 30 +++++++ tests/CommandTest.php | 15 ++++ 16 files changed, 469 insertions(+) create mode 100644 .editorconfig create mode 100644 .gitattributes create mode 100644 .gitignore create mode 100644 .scrutinizer.yml create mode 100644 .styleci.yml create mode 100644 .travis.yml create mode 100644 CHANGELOG.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE.md create mode 100644 README.md create mode 100644 composer.json create mode 100644 phpunit.xml.dist create mode 100644 src/Commands/SchemaTableCommand.php create mode 100644 src/LaravelCliSchema.php create mode 100644 src/LaravelCliSchemaServiceProvider.php create mode 100644 tests/CommandTest.php diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..cd8eb86 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,15 @@ +; This file is for unifying the coding style for different editors and IDEs. +; More information at http://editorconfig.org + +root = true + +[*] +charset = utf-8 +indent_size = 4 +indent_style = space +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true + +[*.md] +trim_trailing_whitespace = false diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..bb6265e --- /dev/null +++ b/.gitattributes @@ -0,0 +1,11 @@ +# Path-based git attributes +# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html + +# Ignore all test and documentation with "export-ignore". +/.gitattributes export-ignore +/.gitignore export-ignore +/.travis.yml export-ignore +/phpunit.xml.dist export-ignore +/.scrutinizer.yml export-ignore +/tests export-ignore +/.editorconfig export-ignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..808f8c5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +build +composer.lock +docs +vendor +coverage \ No newline at end of file diff --git a/.scrutinizer.yml b/.scrutinizer.yml new file mode 100644 index 0000000..df16b68 --- /dev/null +++ b/.scrutinizer.yml @@ -0,0 +1,19 @@ +filter: + excluded_paths: [tests/*] + +checks: + php: + remove_extra_empty_lines: true + remove_php_closing_tag: true + remove_trailing_whitespace: true + fix_use_statements: + remove_unused: true + preserve_multiple: false + preserve_blanklines: true + order_alphabetically: true + fix_php_opening_tag: true + fix_linefeed: true + fix_line_ending: true + fix_identation_4spaces: true + fix_doc_comments: true + diff --git a/.styleci.yml b/.styleci.yml new file mode 100644 index 0000000..f4d3cbc --- /dev/null +++ b/.styleci.yml @@ -0,0 +1,4 @@ +preset: laravel + +disabled: + - single_class_element_per_statement diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..24c2d6c --- /dev/null +++ b/.travis.yml @@ -0,0 +1,21 @@ +language: php + +php: + - 7.1 + - 7.2 + - 7.3 + +env: + matrix: + - COMPOSER_FLAGS="--prefer-lowest" + - COMPOSER_FLAGS="" + +before_script: + - travis_retry composer self-update + - travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-source + +script: + - vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover + +after_script: + - php vendor/bin/ocular code-coverage:upload --format=php-clover coverage.clover diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..20350f0 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog + +All notable changes to `laravel-cli-schema` will be documented in this file + +## 1.0.0 - 201X-XX-XX + +- initial release diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b4ae1c4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,55 @@ +# Contributing + +Contributions are **welcome** and will be fully **credited**. + +Please read and understand the contribution guide before creating an issue or pull request. + +## Etiquette + +This project is open source, and as such, the maintainers give their free time to build and maintain the source code +held within. They make the code freely available in the hope that it will be of use to other developers. It would be +extremely unfair for them to suffer abuse or anger for their hard work. + +Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the +world that developers are civilized and selfless people. + +It's the duty of the maintainer to ensure that all submissions to the project are of sufficient +quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used. + +## Viability + +When requesting or submitting new features, first consider whether it might be useful to others. Open +source projects are used by many developers, who may have entirely different needs to your own. Think about +whether or not your feature is likely to be used by other users of the project. + +## Procedure + +Before filing an issue: + +- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident. +- Check to make sure your feature suggestion isn't already present within the project. +- Check the pull requests tab to ensure that the bug doesn't have a fix in progress. +- Check the pull requests tab to ensure that the feature isn't already in progress. + +Before submitting a pull request: + +- Check the codebase to ensure that your feature doesn't already exist. +- Check the pull requests to ensure that another person hasn't already submitted the feature or fix. + +## Requirements + +If the project maintainer has any additional requirements, you will find them listed here. + +- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://pear.php.net/package/PHP_CodeSniffer). + +- **Add tests!** - Your patch won't be accepted if it doesn't have tests. + +- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date. + +- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option. + +- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests. + +- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting. + +**Happy coding**! diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..b0e8349 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) resohead + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..6910dbf --- /dev/null +++ b/README.md @@ -0,0 +1,70 @@ +# View database table information from Laravel CLI (Artisan) + +[![Latest Version on Packagist](https://img.shields.io/packagist/v/resohead/laravel-cli-schema.svg?style=flat-square)](https://packagist.org/packages/resohead/laravel-cli-schema) + +A small Laravel package to show basic database tables and column information from an Artisan command. + +## Installation + +You can install the package via composer: + +```bash +composer require resohead/laravel-cli-schema {--dev} +``` + +## Usage + +Get all tables and columns +```bash +php artisan schema:table +``` + +Get a list of all tables +```bash +php artisan schema:table --list +``` + +Get a column information for a table +```bash +php artisan schema:table --name=users +``` + +Get a column information for a table via prompt with select list +```bash +php artisan schema:table --name= + +Select a table: +> users +``` + +Get a column information for a model +```bash +php artisan schema:table --model=App\\User +``` + +### Testing + +``` bash +composer test +``` + +### Changelog + +Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. + +## Contributing + +Please see [CONTRIBUTING](CONTRIBUTING.md) for details. + +### Security + +If you discover any security related issues, please email s.white9904@gmail.com instead of using the issue tracker. + +## Credits + +- [resohead](https://github.com/resohead) +- [All Contributors](../../contributors) + +## License + +The MIT License (MIT). Please see [License File](LICENSE.md) for more information. \ No newline at end of file diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..e25cd93 --- /dev/null +++ b/composer.json @@ -0,0 +1,54 @@ +{ + "name": "resohead/laravel-cli-schema", + "description": "List database table schema from Artisan (Laravel CLI)", + "keywords": [ + "resohead", + "laravel-cli-schema" + ], + "homepage": "https://github.com/resohead/laravel-cli-schema", + "license": "MIT", + "type": "library", + "authors": [ + { + "name": "resohead", + "email": "s.white9904@gmail.com", + "role": "Developer" + } + ], + "require": { + "php": "^7.1", + "illuminate/support": "^6.0|^7.0" + }, + "require-dev": { + "orchestra/testbench": "^4.0|^5.0", + "phpunit/phpunit": "^8.0" + }, + "autoload": { + "psr-4": { + "Resohead\\LaravelCliSchema\\": "src" + } + }, + "autoload-dev": { + "psr-4": { + "Resohead\\LaravelCliSchema\\Tests\\": "tests" + } + }, + "scripts": { + "test": "vendor/bin/phpunit", + "test-coverage": "vendor/bin/phpunit --coverage-html coverage" + + }, + "config": { + "sort-packages": true + }, + "extra": { + "laravel": { + "providers": [ + "Resohead\\LaravelCliSchema\\LaravelCliSchemaServiceProvider" + ], + "aliases": { + "LaravelCliSchema": "Resohead\\LaravelCliSchema\\LaravelCliSchemaFacade" + } + } + } +} diff --git a/phpunit.xml.dist b/phpunit.xml.dist new file mode 100644 index 0000000..22fe879 --- /dev/null +++ b/phpunit.xml.dist @@ -0,0 +1,29 @@ + + + + + tests + + + + + src/ + + + + + + + + + + diff --git a/src/Commands/SchemaTableCommand.php b/src/Commands/SchemaTableCommand.php new file mode 100644 index 0000000..88cf1d6 --- /dev/null +++ b/src/Commands/SchemaTableCommand.php @@ -0,0 +1,105 @@ +tables = $this->getTables(); + } + + /** + * Execute the console command. + * + * @return mixed + */ + public function handle() + { + $tableName = $this->getTableParameter(); + + if($this->option('list') && empty($tableName)){ + $this->table(['table'], + $this->tables->map(function($table){ + return [$table]; + }) + ); + return 0; + } + $this->tables + ->filter(function($table) use ($tableName){ + return $tableName ? $table === $tableName : true; + }) + ->each(function($table){ + $columns = $this->getColumns($table)->map(function($column){ + return [$column]; + }); + $this->table([$table], $columns); + }); + return 0; + } + + protected function getTables() + { + return collect(Schema::getAllTables()) + ->map(function($table){ + return $table->tablename; + }) + ->sort(); + } + + protected function getColumns(string $table) + { + return collect(Schema::getColumnListing($table)); + } + + protected function getTableParameter() + { + $name = $this->option('name'); + + if($name === ''){ + return $this->anticipate('Select a table', $this->tables->toArray()); + } + return $name ?? $this->getModelParameter(); + } + + protected function getModelParameter() + { + $model = $this->option('model'); + return empty($model) ? null : $this->getModelTable($model); + } + + protected function getModelTable($model) + { + if(class_exists($model)){ + return with(new $model)->getTable(); + } + $this->error("Unable to find a table for ${model}"); + return $model; + } +} diff --git a/src/LaravelCliSchema.php b/src/LaravelCliSchema.php new file mode 100644 index 0000000..caaee00 --- /dev/null +++ b/src/LaravelCliSchema.php @@ -0,0 +1,8 @@ +app->runningInConsole()) { + $this->commands([ + SchemaTableCommand::class + ]); + } + } + + /** + * Register the application services. + */ + public function register() + { + // + } +} diff --git a/tests/CommandTest.php b/tests/CommandTest.php new file mode 100644 index 0000000..e91f0be --- /dev/null +++ b/tests/CommandTest.php @@ -0,0 +1,15 @@ +