Skip to content

Commit 23c2808

Browse files
danilopolanidanilopolani
committed
Hello world
0 parents  commit 23c2808

14 files changed

+497
-0
lines changed

‎.editorconfig‎

Lines changed: 15 additions & 0 deletions
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‎

Lines changed: 11 additions & 0 deletions
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‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
build
2+
composer.lock
3+
docs
4+
vendor
5+
coverage
6+
.phpunit.result.cache

‎.styleci.yml‎

Lines changed: 4 additions & 0 deletions
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‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
language: php
2+
3+
php:
4+
- 7.4
5+
- 8.0
6+
7+
before_script:
8+
- travis_retry composer self-update
9+
- travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-source
10+
11+
script:
12+
- vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover
13+
14+
after_script:
15+
- php vendor/bin/ocular code-coverage:upload --format=php-clover coverage.clover

‎CHANGELOG.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Changelog
2+
3+
All notable changes to the package will be documented in this file.
4+
5+
## 1.0.0 - 2021-02-26
6+
7+
- First release

‎CONTRIBUTING.md‎

Lines changed: 55 additions & 0 deletions
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‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) Danilo Polani
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 all
13+
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 THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
# Laravel Array Destructuring
2+
3+
[![Latest Version on Packagist](https://img.shields.io/packagist/v/danilopolani/laravel-array-destructuring.svg?style=flat-square)](https://packagist.org/packages/danilopolani/laravel-array-destructuring)
4+
[![Build Status](https://travis-ci.com/danilopolani/laravel-array-destructuring.svg)](https://travis-ci.com/danilopolani/laravel-array-destructuring)
5+
6+
<!-- PROJECT LOGO -->
7+
<br />
8+
<p align="center">
9+
<a href="https://github.com/danilopolani/laravel-array-destructuring">
10+
<img src="https://banners.beyondco.de/Laravel%20Array%20Destructuring.png?theme=light&packageManager=composer+require&packageName=danilopolani%2Flaravel-array-destructuring&pattern=dominos&style=style_1&description=Powerful+array+destructuring+for+Laravel&md=1&showWatermark=1&fontSize=100px&images=dots-horizontal">
11+
</a>
12+
</p>
13+
14+
15+
Extend `Arr` support adding a `destructure` method to have a powerful array destruction in Laravel.
16+
17+
<!-- TABLE OF CONTENTS -->
18+
## Table of Contents
19+
<ol>
20+
<li><a href="#installation">Installation</a></li>
21+
<li><a href="#usage">Usage</a></li>
22+
<li><a href="#changelog">Changelog</a></li>
23+
<li><a href="#contributing">Contributing</a></li>
24+
<li><a href="#testing">Testing</a></li>
25+
<li><a href="#security">Security</a></li>
26+
<li><a href="#credits">Credits</a></li>
27+
<li><a href="#license">License</a></li>
28+
</ol>
29+
30+
<!-- GETTING STARTED -->
31+
## Installation
32+
33+
The package supports `Laravel 8.x` and `PHP >= 7.4`.
34+
35+
You can install the package via composer:
36+
37+
```bash
38+
composer require danilopolani/laravel-array-destructuring
39+
```
40+
41+
Thanks to the package auto-discovery feature, it will register itself automatically.
42+
43+
## Usage
44+
45+
> **Note**: if a key is not found its value will be `null`. If all the elements inside a group of keys are not found, the returned value will be an empty array `[]`.
46+
47+
Basic destructuring for a key only
48+
49+
```php
50+
$post = [
51+
'title' => 'Article 1',
52+
'slug' => 'article-1',
53+
'description' => 'Lorem ipsum',
54+
'tags' => ['foo', 'bar'],
55+
'gallery' => [
56+
['image' => 'image.jpg'],
57+
['image' => 'image2.jpg'],
58+
],
59+
];
60+
61+
[$tags, $article] = Arr::destructure($post, 'tags');
62+
63+
dump($tags); // ['foo', 'bar']
64+
dump($article) // ['title' => 'Article 1', 'slug' => 'article-1', ...] without tags
65+
66+
[$notFoundKey, $article] = Arr::destructure($post, 'notFoundKey');
67+
68+
dump($notFoundKey); // null
69+
```
70+
71+
Destructuring with multiple keys
72+
73+
```php
74+
$post = [
75+
'title' => 'Article 1',
76+
'slug' => 'article-1',
77+
'description' => 'Lorem ipsum',
78+
'tags' => ['foo', 'bar'],
79+
'gallery' => [
80+
['image' => 'image.jpg'],
81+
['image' => 'image2.jpg'],
82+
],
83+
];
84+
85+
[$tags, $gallery, $article] = Arr::destructure($post, ['tags', 'gallery']);
86+
87+
dump($tags); // ['foo', 'bar']
88+
dump($gallery); // [['image' => 'image.jpg'], ['image' => 'image2.jpg']]
89+
dump($article) // ['title' => 'Article 1', 'slug' => 'article-1', ...] without tags and gallery
90+
```
91+
92+
Destructuring with multiple grouped keys
93+
94+
```php
95+
$post = [
96+
'title' => 'Article 1',
97+
'slug' => 'article-1',
98+
'description' => 'Lorem ipsum',
99+
'tags' => ['foo', 'bar'],
100+
'gallery' => [
101+
['image' => 'image.jpg'],
102+
['image' => 'image2.jpg'],
103+
],
104+
];
105+
106+
[$slug, $meta, $article] = Arr::destructure($post, ['slug', ['tags', 'gallery']]);
107+
108+
dump($slug); // article-1
109+
dump($meta); // ['tags' => ['foo', 'bar'], 'gallery' => ['image' => 'image.jpg'], ['image' => 'image2.jpg']]
110+
dump($article) // ['title' => 'Article 1', 'slug' => 'article-1', ...] without slug, tags and gallery
111+
112+
[$notFoundGroup, $article] = Arr::destructure($post, [['notFound1', 'notFound2']]);
113+
114+
dump($notFoundGroup); // []
115+
```
116+
117+
## Changelog
118+
119+
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
120+
121+
## Contributing
122+
123+
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
124+
125+
## Testing
126+
127+
Clone the repository and just run
128+
129+
``` bash
130+
composer test
131+
```
132+
133+
With Docker (Windows):
134+
135+
```bash
136+
docker run --rm -v %cd%:/app composer:latest bash -c "cd /app && composer install --ignore-platform-reqs && ./vendor/bin/phpunit"
137+
```
138+
139+
With Docker (Linux/OSX):
140+
141+
```bash
142+
docker run --rm -v $(pwd):/app composer:latest bash -c "cd /app && composer install && ./vendor/bin/phpunit"
143+
```
144+
145+
## Security
146+
147+
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
148+
149+
## Credits
150+
151+
- [Danilo Polani](https://github.com/danilopolani)
152+
- [All Contributors](../../contributors)
153+
154+
## License
155+
156+
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
157+
158+
## Laravel Package Boilerplate
159+
160+
This package was generated using the [Laravel Package Boilerplate](https://laravelpackageboilerplate.com).

‎composer.json‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
{
2+
"name": "danilopolani/laravel-array-destructuring",
3+
"description": "Powerful array destructuring for Laravel",
4+
"keywords": [
5+
"theraloss",
6+
"array destructuring",
7+
"laravel"
8+
],
9+
"homepage": "https://github.com/danilopolani/laravel-array-destructuring",
10+
"license": "MIT",
11+
"type": "library",
12+
"authors": [
13+
{
14+
"name": "Danilo Polani",
15+
"email": "[email protected]",
16+
"role": "Developer"
17+
}
18+
],
19+
"require": {
20+
"php": "^7.4|^8.0",
21+
"illuminate/support": "^8.0"
22+
},
23+
"require-dev": {
24+
"orchestra/testbench": "^6.0",
25+
"phpunit/phpunit": "^9.0"
26+
},
27+
"autoload": {
28+
"psr-4": {
29+
"Danilopolani\\ArrayDestructuring\\": "src"
30+
}
31+
},
32+
"autoload-dev": {
33+
"psr-4": {
34+
"Danilopolani\\ArrayDestructuring\\Tests\\": "tests"
35+
}
36+
},
37+
"scripts": {
38+
"test": "vendor/bin/phpunit",
39+
"test-coverage": "vendor/bin/phpunit --coverage-html coverage"
40+
},
41+
"config": {
42+
"sort-packages": true
43+
},
44+
"extra": {
45+
"laravel": {
46+
"providers": [
47+
"Danilopolani\\ArrayDestructuring\\ArrayDestructuringServiceProvider"
48+
]
49+
}
50+
}
51+
}

0 commit comments

Comments
 (0)