Skip to content

Commit 045b969

Browse files
mpociotmpociot
committed
Initial commit
0 parents  commit 045b969

19 files changed

+513
-0
lines changed

‎.editorconfig

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
; This file is for unifying the coding style for different editors and IDEs.
2+
; More information at http://editorconfig.org
3+
4+
root = true
5+
6+
[*]
7+
charset = utf-8
8+
indent_size = 4
9+
indent_style = space
10+
end_of_line = lf
11+
insert_final_newline = true
12+
trim_trailing_whitespace = true
13+
14+
[*.md]
15+
trim_trailing_whitespace = false

‎.gitattributes

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Path-based git attributes
2+
# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
3+
4+
# Ignore all test and documentation with "export-ignore".
5+
/.gitattributes export-ignore
6+
/.gitignore export-ignore
7+
/.travis.yml export-ignore
8+
/phpunit.xml.dist export-ignore
9+
/.scrutinizer.yml export-ignore
10+
/tests export-ignore
11+
/.editorconfig export-ignore

‎.gitignore

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
build
2+
composer.lock
3+
docs
4+
vendor
5+
coverage
6+
.idea

‎.scrutinizer.yml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
filter:
2+
excluded_paths: [tests/*]
3+
4+
checks:
5+
php:
6+
remove_extra_empty_lines: true
7+
remove_php_closing_tag: true
8+
remove_trailing_whitespace: true
9+
fix_use_statements:
10+
remove_unused: true
11+
preserve_multiple: false
12+
preserve_blanklines: true
13+
order_alphabetically: true
14+
fix_php_opening_tag: true
15+
fix_linefeed: true
16+
fix_line_ending: true
17+
fix_identation_4spaces: true
18+
fix_doc_comments: true
19+

‎.styleci.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
preset: laravel
2+
3+
disabled:
4+
- single_class_element_per_statement

‎.travis.yml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
language: php
2+
3+
php:
4+
- 7.1
5+
- 7.2
6+
7+
env:
8+
matrix:
9+
- COMPOSER_FLAGS="--prefer-lowest"
10+
- COMPOSER_FLAGS=""
11+
12+
before_script:
13+
- travis_retry composer self-update
14+
- travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-source
15+
16+
script:
17+
- vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover
18+
19+
after_script:
20+
- php vendor/bin/ocular code-coverage:upload --format=php-clover coverage.clover

‎CHANGELOG.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Changelog
2+
3+
All notable changes to `laravel-dump-server` will be documented in this file
4+
5+
## 1.0.0 - 201X-XX-XX
6+
7+
- initial release

‎CONTRIBUTING.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Contributing
2+
3+
Contributions are **welcome** and will be fully **credited**.
4+
5+
Please read and understand the contribution guide before creating an issue or pull request.
6+
7+
## Etiquette
8+
9+
This project is open source, and as such, the maintainers give their free time to build and maintain the source code
10+
held within. They make the code freely available in the hope that it will be of use to other developers. It would be
11+
extremely unfair for them to suffer abuse or anger for their hard work.
12+
13+
Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
14+
world that developers are civilized and selfless people.
15+
16+
It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
17+
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.
18+
19+
## Viability
20+
21+
When requesting or submitting new features, first consider whether it might be useful to others. Open
22+
source projects are used by many developers, who may have entirely different needs to your own. Think about
23+
whether or not your feature is likely to be used by other users of the project.
24+
25+
## Procedure
26+
27+
Before filing an issue:
28+
29+
- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
30+
- Check to make sure your feature suggestion isn't already present within the project.
31+
- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
32+
- Check the pull requests tab to ensure that the feature isn't already in progress.
33+
34+
Before submitting a pull request:
35+
36+
- Check the codebase to ensure that your feature doesn't already exist.
37+
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
38+
39+
## Requirements
40+
41+
If the project maintainer has any additional requirements, you will find them listed here.
42+
43+
- **[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).
44+
45+
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
46+
47+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
48+
49+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
50+
51+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
52+
53+
- **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.
54+
55+
**Happy coding**!

‎LICENSE.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) Beyond Code GmbH <[email protected]>
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

‎README.md

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Laravel Dump Server
2+
3+
[![Latest Version on Packagist](https://img.shields.io/packagist/v/beyondcode/laravel-dump-server.svg?style=flat-square)](https://packagist.org/packages/beyondcode/laravel-dump-server)
4+
[![Quality Score](https://img.shields.io/scrutinizer/g/beyondcode/laravel-dump-server.svg?style=flat-square)](https://scrutinizer-ci.com/g/beyondcode/laravel-dump-server)
5+
[![Total Downloads](https://img.shields.io/packagist/dt/beyondcode/laravel-dump-server.svg?style=flat-square)](https://packagist.org/packages/beyondcode/laravel-dump-server)
6+
7+
Bringing the Symfony Var-Dump Server to Laravel.
8+
9+
This package will give you a dump server, that collects all your `dump` call outputs, so that it does not interfere with HTTP / API responses.
10+
11+
## Installation
12+
13+
You can install the package via composer:
14+
15+
```bash
16+
composer require beyondcode/laravel-dump-server
17+
```
18+
19+
The package will register itself automatically.
20+
21+
Optionally you can publish the package configuration using:
22+
23+
```bash
24+
php artisan vendor:publish --provider=BeyondCode\\DumpServer\\DumpServerServiceProvider
25+
```
26+
27+
This will publish a file called `debug-server.php` in your `config` folder.
28+
In the config file, you can specify the dump server host that you want to listen on, in case you want to change the default value.
29+
30+
## Usage
31+
32+
Start the dump server by calling the artisan command:
33+
34+
```bash
35+
php artisan dump-server
36+
```
37+
38+
And then you can, as you are used to, put `dump` calls in your methods. But instead of dumping the output in your current HTTP request, they will be dumped in the artisan command.
39+
This is very useful, when you want to dump data from API requests, without having to deal with HTTP errors.
40+
41+
You can see it in action here:
42+
43+
![Dump Server Demo](https://beyondco.de/github/dumpserver/dumpserver.gif)
44+
45+
### Changelog
46+
47+
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
48+
49+
## Contributing
50+
51+
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
52+
53+
### Security
54+
55+
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
56+
57+
## Credits
58+
59+
- [Marcel Pociot](https://github.com/mpociot)
60+
- [All Contributors](../../contributors)
61+
62+
## License
63+
64+
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
65+

‎composer.json

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
{
2+
"name": "beyondcode/laravel-dump-server",
3+
"description": "Symfony Var-Dump Server for Laravel",
4+
"keywords": [
5+
"beyondcode",
6+
"laravel-dump-server"
7+
],
8+
"homepage": "https://github.com/beyondcode/laravel-dump-server",
9+
"license": "MIT",
10+
"authors": [
11+
{
12+
"name": "Marcel Pociot",
13+
"email": "[email protected]",
14+
"homepage": "https://beyondcode.de",
15+
"role": "Developer"
16+
}
17+
],
18+
"require": {
19+
"php": "^7.1",
20+
"illuminate/console": "5.6.*",
21+
"illuminate/support": "5.6.*",
22+
"symfony/http-foundation": "~4.1",
23+
"illuminate/http": "5.6.*"
24+
},
25+
"require-dev": {
26+
"larapack/dd": "^1.0",
27+
"phpunit/phpunit": "^7.0"
28+
},
29+
"autoload": {
30+
"psr-4": {
31+
"BeyondCode\\DumpServer\\": "src"
32+
}
33+
},
34+
"autoload-dev": {
35+
"psr-4": {
36+
"BeyondCode\\DumpServer\\Tests\\": "tests"
37+
}
38+
},
39+
"scripts": {
40+
"test": "vendor/bin/phpunit",
41+
"test-coverage": "vendor/bin/phpunit --coverage-html coverage"
42+
43+
},
44+
"config": {
45+
"sort-packages": true
46+
},
47+
"extra": {
48+
"laravel": {
49+
"providers": [
50+
"BeyondCode\\DumpServer\\DumpServerServiceProvider"
51+
],
52+
"aliases": {
53+
"DumpServer": "BeyondCode\\DumpServer\\DumpServerFacade"
54+
}
55+
}
56+
}
57+
}

‎config/.gitkeep

Whitespace-only changes.

‎config/config.php

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<?php
2+
3+
return [
4+
/*
5+
* The host to use when listening for debug server connections.
6+
*/
7+
'host' => 'tcp://0.0.0.0:9912'
8+
];

‎phpunit.xml.dist

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<phpunit bootstrap="vendor/autoload.php"
3+
backupGlobals="false"
4+
backupStaticAttributes="false"
5+
colors="true"
6+
verbose="true"
7+
convertErrorsToExceptions="true"
8+
convertNoticesToExceptions="true"
9+
convertWarningsToExceptions="true"
10+
processIsolation="false"
11+
stopOnFailure="false">
12+
<testsuites>
13+
<testsuite name="BeyondCode Test Suite">
14+
<directory>tests</directory>
15+
</testsuite>
16+
</testsuites>
17+
<filter>
18+
<whitelist>
19+
<directory suffix=".php">src/</directory>
20+
</whitelist>
21+
</filter>
22+
<logging>
23+
<log type="tap" target="build/report.tap"/>
24+
<log type="junit" target="build/report.junit.xml"/>
25+
<log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>
26+
<log type="coverage-text" target="build/coverage.txt"/>
27+
<log type="coverage-clover" target="build/logs/clover.xml"/>
28+
</logging>
29+
</phpunit>

‎src/DumpServerCommand.php

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<?php
2+
3+
namespace BeyondCode\DumpServer;
4+
5+
use Illuminate\Console\Command;
6+
7+
use Symfony\Component\VarDumper\Cloner\Data;
8+
use Symfony\Component\VarDumper\Dumper\CliDumper;
9+
use Symfony\Component\VarDumper\Server\DumpServer;
10+
use Symfony\Component\VarDumper\Command\Descriptor\CliDescriptor;
11+
12+
class DumpServerCommand extends Command
13+
{
14+
/**
15+
* The console command name.
16+
*
17+
* @var string
18+
*/
19+
protected $signature = 'dump-server';
20+
/**
21+
* The console command description.
22+
*
23+
* @var string
24+
*/
25+
protected $description = 'Start the dump server to collect dump information.';
26+
27+
private $server;
28+
29+
public function __construct(DumpServer $server)
30+
{
31+
$this->server = $server;
32+
33+
parent::__construct();
34+
}
35+
36+
public function handle()
37+
{
38+
$descriptor = new CliDescriptor(new CliDumper());
39+
40+
$this->server->start();
41+
42+
$this->output->title('Laravel Var Dump Server');
43+
$this->output->success(sprintf('Server listening on %s', $this->server->getHost()));
44+
$this->output->comment('Quit the server with CONTROL-C.');
45+
46+
$this->server->listen(function (Data $data, array $context, int $clientId) use ($descriptor) {
47+
$descriptor->describe($this->output, $data, $context, $clientId);
48+
});
49+
}
50+
51+
}

0 commit comments

Comments
 (0)