Skip to content

Commit

Permalink
Update examples and README
Browse files Browse the repository at this point in the history
  • Loading branch information
@macocci7
macocci7 committed Apr 18, 2024
1 parent e800a36 commit bafd68d
Show file tree
Hide file tree
Showing 11 changed files with 71 additions and 71 deletions.
71 changes: 38 additions & 33 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
- create `pairs`
- create all combinations `of N` elements
- create all combinations `of A 2 B` elements

- create all combinations between multiple arrays

## 2. Contents
- [1. Features](#1-features)
Expand Down Expand Up @@ -163,7 +163,7 @@ The max index number of array in PHP equals to `PHP_INT_MAX`.
```php
<?php

require_once('../vendor/autoload.php');
require_once __DIR__ . '/../vendor/autoload.php';

use Macocci7\PhpCombination\Combination;

Expand Down Expand Up @@ -198,7 +198,7 @@ The max index number of array in PHP equals to `PHP_INT_MAX`.
```php
<?php

require_once('../vendor/autoload.php');
require_once __DIR__ . '/../vendor/autoload.php';

use Macocci7\PhpCombination\CombinationGenerator;

Expand Down Expand Up @@ -233,7 +233,7 @@ The max index number of array in PHP equals to `PHP_INT_MAX`.
```php
<?php

require_once('../vendor/autoload.php');
require_once __DIR__ . '/../vendor/autoload.php';

use Macocci7\PhpCombination\Combination;

Expand Down Expand Up @@ -415,7 +415,7 @@ The max index number of array in PHP equals to `PHP_INT_MAX`.
```php
<?php

require_once('../vendor/autoload.php');
require_once __DIR__ . '/../vendor/autoload.php';

use Macocci7\PhpCombination\Combination;

Expand Down Expand Up @@ -600,7 +600,7 @@ The max index number of array in PHP equals to `PHP_INT_MAX`.
```php
<?php

require_once('../vendor/autoload.php');
require_once __DIR__ . '/../vendor/autoload.php';

use Macocci7\PhpCombination\CombinationGenerator;

Expand Down Expand Up @@ -821,6 +821,11 @@ with patterns of `size`, `color` and `amount`.
return $data;
}

/**
* PHPDoc for PHPUnit 9.x
* @dataProvider provide_order_can_order_correctly
*/
// Attribute for PHPUnit 10.x or later
#[DataProvider('provide_order_can_order_correctly')]
public function test_order_can_order_correctly(
int $productId,
Expand All @@ -843,13 +848,13 @@ with patterns of `size`, `color` and `amount`.

```bash
$ vendor/bin/phpunit ./examples/UseInPhpUnitTest.php --color=auto --testdox
PHPUnit 10.5.18 by Sebastian Bergmann and contributors.
PHPUnit 10.5.19 by Sebastian Bergmann and contributors.

Runtime: PHP 8.2.13
Runtime: PHP 8.1.26

........................ 24 / 24 (100%)

Time: 00:00.076, Memory: 8.00 MB
Time: 00:00.053, Memory: 8.00 MB

Use In Php Unit (Macocci7\PhpCombination\UseInPhpUnit)
✔ Order can order correctly with 1101,·S,·White,·1
Expand Down Expand Up @@ -883,30 +888,30 @@ with patterns of `size`, `color` and `amount`.
- Result: LOG

```log
[2024-04-18T00:25:01.221482+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"S","color":"White","amount":1} []
[2024-04-18T00:25:01.237957+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"S","color":"White","amount":2} []
[2024-04-18T00:25:01.238915+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"S","color":"Black","amount":1} []
[2024-04-18T00:25:01.239725+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"S","color":"Black","amount":2} []
[2024-04-18T00:25:01.240554+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"M","color":"White","amount":1} []
[2024-04-18T00:25:01.241492+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"M","color":"White","amount":2} []
[2024-04-18T00:25:01.242484+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"M","color":"Black","amount":1} []
[2024-04-18T00:25:01.243489+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"M","color":"Black","amount":2} []
[2024-04-18T00:25:01.247389+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"L","color":"White","amount":1} []
[2024-04-18T00:25:01.248891+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"L","color":"White","amount":2} []
[2024-04-18T00:25:01.250689+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"L","color":"Black","amount":1} []
[2024-04-18T00:25:01.251705+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"L","color":"Black","amount":2} []
[2024-04-18T00:25:01.252559+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"S","color":"White","amount":1} []
[2024-04-18T00:25:01.253453+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"S","color":"White","amount":2} []
[2024-04-18T00:25:01.255659+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"S","color":"Black","amount":1} []
[2024-04-18T00:25:01.257999+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"S","color":"Black","amount":2} []
[2024-04-18T00:25:01.259445+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"M","color":"White","amount":1} []
[2024-04-18T00:25:01.260728+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"M","color":"White","amount":2} []
[2024-04-18T00:25:01.262897+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"M","color":"Black","amount":1} []
[2024-04-18T00:25:01.265152+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"M","color":"Black","amount":2} []
[2024-04-18T00:25:01.266253+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"L","color":"White","amount":1} []
[2024-04-18T00:25:01.267110+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"L","color":"White","amount":2} []
[2024-04-18T00:25:01.267956+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"L","color":"Black","amount":1} []
[2024-04-18T00:25:01.270784+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"L","color":"Black","amount":2} []
[2024-04-18T00:46:47.065595+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"S","color":"White","amount":1} []
[2024-04-18T00:46:47.069266+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"S","color":"White","amount":2} []
[2024-04-18T00:46:47.070687+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"S","color":"Black","amount":1} []
[2024-04-18T00:46:47.072942+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"S","color":"Black","amount":2} []
[2024-04-18T00:46:47.074656+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"M","color":"White","amount":1} []
[2024-04-18T00:46:47.077154+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"M","color":"White","amount":2} []
[2024-04-18T00:46:47.078569+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"M","color":"Black","amount":1} []
[2024-04-18T00:46:47.079828+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"M","color":"Black","amount":2} []
[2024-04-18T00:46:47.080988+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"L","color":"White","amount":1} []
[2024-04-18T00:46:47.082439+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"L","color":"White","amount":2} []
[2024-04-18T00:46:47.083968+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"L","color":"Black","amount":1} []
[2024-04-18T00:46:47.084862+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"L","color":"Black","amount":2} []
[2024-04-18T00:46:47.085751+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"S","color":"White","amount":1} []
[2024-04-18T00:46:47.086692+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"S","color":"White","amount":2} []
[2024-04-18T00:46:47.090893+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"S","color":"Black","amount":1} []
[2024-04-18T00:46:47.092489+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"S","color":"Black","amount":2} []
[2024-04-18T00:46:47.094058+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"M","color":"White","amount":1} []
[2024-04-18T00:46:47.095176+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"M","color":"White","amount":2} []
[2024-04-18T00:46:47.096440+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"M","color":"Black","amount":1} []
[2024-04-18T00:46:47.099292+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"M","color":"Black","amount":2} []
[2024-04-18T00:46:47.100918+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"L","color":"White","amount":1} []
[2024-04-18T00:46:47.102176+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"L","color":"White","amount":2} []
[2024-04-18T00:46:47.103248+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"L","color":"Black","amount":1} []
[2024-04-18T00:46:47.106206+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"L","color":"Black","amount":2} []
```

## 9. Examples
Expand Down
7 changes: 4 additions & 3 deletions composer.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "macocci7/php-combination",
"version": "1.0.4",
"version": "1.0.5",
"description": "a simple PHP library to make combinations",
"type": "library",
"license": "MIT",
Expand All @@ -21,9 +21,10 @@
"phpunit/phpunit": "^10.5",
"phpmd/phpmd": "^2.15",
"phpstan/phpstan": "^1.10",
"php-parallel-lint/php-parallel-lint": "^1.3"
"php-parallel-lint/php-parallel-lint": "^1.3",
"monolog/monolog": "^3.5"
},
"require": {
"monolog/monolog": "^3.5"
"php": ">=8.1"
}
}
2 changes: 1 addition & 1 deletion examples/BasicUsage.php
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

require_once('../vendor/autoload.php');
require_once __DIR__ . '/../vendor/autoload.php';

use Macocci7\PhpCombination\Combination;

Expand Down
2 changes: 1 addition & 1 deletion examples/BasicUsageGenerator.php
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

require_once('../vendor/autoload.php');
require_once __DIR__ . '/../vendor/autoload.php';

use Macocci7\PhpCombination\CombinationGenerator;

Expand Down
2 changes: 1 addition & 1 deletion examples/UseCombination.php
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

require_once('../vendor/autoload.php');
require_once __DIR__ . '/../vendor/autoload.php';

use Macocci7\PhpCombination\Combination;

Expand Down
2 changes: 1 addition & 1 deletion examples/UseCombinationGenerator.php
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

require_once('../vendor/autoload.php');
require_once __DIR__ . '/../vendor/autoload.php';

use Macocci7\PhpCombination\CombinationGenerator;

Expand Down
2 changes: 1 addition & 1 deletion examples/UseCombinationSort.php
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

require_once('../vendor/autoload.php');
require_once __DIR__ . '/../vendor/autoload.php';

use Macocci7\PhpCombination\Combination;

Expand Down
48 changes: 24 additions & 24 deletions examples/UseInPhpUnit.log
View file
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
[2024-04-18T00:25:01.221482+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"S","color":"White","amount":1} []
[2024-04-18T00:25:01.237957+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"S","color":"White","amount":2} []
[2024-04-18T00:25:01.238915+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"S","color":"Black","amount":1} []
[2024-04-18T00:25:01.239725+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"S","color":"Black","amount":2} []
[2024-04-18T00:25:01.240554+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"M","color":"White","amount":1} []
[2024-04-18T00:25:01.241492+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"M","color":"White","amount":2} []
[2024-04-18T00:25:01.242484+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"M","color":"Black","amount":1} []
[2024-04-18T00:25:01.243489+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"M","color":"Black","amount":2} []
[2024-04-18T00:25:01.247389+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"L","color":"White","amount":1} []
[2024-04-18T00:25:01.248891+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"L","color":"White","amount":2} []
[2024-04-18T00:25:01.250689+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"L","color":"Black","amount":1} []
[2024-04-18T00:25:01.251705+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"L","color":"Black","amount":2} []
[2024-04-18T00:25:01.252559+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"S","color":"White","amount":1} []
[2024-04-18T00:25:01.253453+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"S","color":"White","amount":2} []
[2024-04-18T00:25:01.255659+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"S","color":"Black","amount":1} []
[2024-04-18T00:25:01.257999+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"S","color":"Black","amount":2} []
[2024-04-18T00:25:01.259445+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"M","color":"White","amount":1} []
[2024-04-18T00:25:01.260728+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"M","color":"White","amount":2} []
[2024-04-18T00:25:01.262897+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"M","color":"Black","amount":1} []
[2024-04-18T00:25:01.265152+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"M","color":"Black","amount":2} []
[2024-04-18T00:25:01.266253+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"L","color":"White","amount":1} []
[2024-04-18T00:25:01.267110+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"L","color":"White","amount":2} []
[2024-04-18T00:25:01.267956+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"L","color":"Black","amount":1} []
[2024-04-18T00:25:01.270784+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"L","color":"Black","amount":2} []
[2024-04-18T00:46:47.065595+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"S","color":"White","amount":1} []
[2024-04-18T00:46:47.069266+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"S","color":"White","amount":2} []
[2024-04-18T00:46:47.070687+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"S","color":"Black","amount":1} []
[2024-04-18T00:46:47.072942+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"S","color":"Black","amount":2} []
[2024-04-18T00:46:47.074656+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"M","color":"White","amount":1} []
[2024-04-18T00:46:47.077154+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"M","color":"White","amount":2} []
[2024-04-18T00:46:47.078569+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"M","color":"Black","amount":1} []
[2024-04-18T00:46:47.079828+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"M","color":"Black","amount":2} []
[2024-04-18T00:46:47.080988+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"L","color":"White","amount":1} []
[2024-04-18T00:46:47.082439+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"L","color":"White","amount":2} []
[2024-04-18T00:46:47.083968+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"L","color":"Black","amount":1} []
[2024-04-18T00:46:47.084862+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1101,"size":"L","color":"Black","amount":2} []
[2024-04-18T00:46:47.085751+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"S","color":"White","amount":1} []
[2024-04-18T00:46:47.086692+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"S","color":"White","amount":2} []
[2024-04-18T00:46:47.090893+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"S","color":"Black","amount":1} []
[2024-04-18T00:46:47.092489+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"S","color":"Black","amount":2} []
[2024-04-18T00:46:47.094058+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"M","color":"White","amount":1} []
[2024-04-18T00:46:47.095176+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"M","color":"White","amount":2} []
[2024-04-18T00:46:47.096440+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"M","color":"Black","amount":1} []
[2024-04-18T00:46:47.099292+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"M","color":"Black","amount":2} []
[2024-04-18T00:46:47.100918+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"L","color":"White","amount":1} []
[2024-04-18T00:46:47.102176+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"L","color":"White","amount":2} []
[2024-04-18T00:46:47.103248+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"L","color":"Black","amount":1} []
[2024-04-18T00:46:47.106206+00:00] UseInPhpUnit.INFO: Adding a new order {"productId":1102,"size":"L","color":"Black","amount":2} []
2 changes: 0 additions & 2 deletions tests/CombinationGeneratorTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@

namespace Macocci7\PhpCombination;

require('vendor/autoload.php');

use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
use Macocci7\PhpCombination\Util;
Expand Down
2 changes: 0 additions & 2 deletions tests/CombinationTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@

namespace Macocci7\PhpCombination;

require('vendor/autoload.php');

use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
use Macocci7\PhpCombination\Util;
Expand Down
2 changes: 0 additions & 2 deletions tests/UtilTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@

namespace Macocci7\PhpCombination;

require('vendor/autoload.php');

use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
use Macocci7\PhpCombination\Util;
Expand Down

0 comments on commit bafd68d

Please sign in to comment.