Skip to content

Commit 8f4bf84

Browse files
roxblnfkroxblnfk
authored
Prepare to release (#3)
1 parent 6e11429 commit 8f4bf84

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+1394
-1217
lines changed

‎.github/workflows/main.yml

+11-17
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
strategy:
1515
fail-fast: false
1616
matrix:
17-
php: [ '7.4', '8.0' ]
17+
php: [ '7.4', '8.0', '8.1' ]
1818
os: [ ubuntu-latest ]
1919
stability: [ prefer-lowest, prefer-stable ]
2020

@@ -43,25 +43,19 @@ jobs:
4343
id: composer-cache
4444
run: echo "::set-output name=dir::$(composer config cache-files-dir)"
4545
- name: Restore Composer Cache
46-
uses: actions/cache@v1
46+
uses: actions/cache@v2
4747
with:
4848
path: ${{ steps.composer-cache.outputs.dir }}
4949
key: ${{ runner.os }}-${{ matrix.php }}-composer-${{ hashFiles('**/composer.json') }}
5050
restore-keys: ${{ runner.os }}-${{ matrix.php }}-composer-
51-
- name: Install Dependencies
52-
uses: nick-invision/retry@v1
53-
with:
54-
timeout_minutes: 5
55-
max_attempts: 5
56-
command: composer update --${{ matrix.stability }} --prefer-dist --no-interaction --no-progress
57-
# Upgrade mockery on PHP 8
58-
- name: Install Dependencies
59-
if: ${{ matrix.php == '8.0' }}
60-
uses: nick-invision/retry@v1
61-
with:
62-
timeout_minutes: 5
63-
max_attempts: 5
64-
command: composer update mockery/mockery --prefer-dist --no-interaction --no-progress
51+
52+
- name: Install dependencies with composer
53+
if: matrix.php-version != '8.1'
54+
run: composer update --${{ matrix.stability }} --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
55+
56+
- name: Install dependencies with composer php 8.1
57+
if: matrix.php-version == '8.1'
58+
run: composer update --${{ matrix.stability }} --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi --ignore-platform-reqs
6559

6660
# Execution
6761
- name: Execute Tests
@@ -71,4 +65,4 @@ jobs:
7165
with:
7266
token: ${{ secrets.CODECOV_TOKEN }}
7367
file: ./coverage.xml
74-
fail_ci_if_error: false
68+
fail_ci_if_error: false

‎.github/workflows/static.yml

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: static analysis
2+
3+
on:
4+
pull_request:
5+
push:
6+
schedule:
7+
- cron: '0 0 * * *'
8+
9+
jobs:
10+
mutation:
11+
name: PHP ${{ matrix.php }}-${{ matrix.os }}
12+
13+
runs-on: ${{ matrix.os }}
14+
15+
strategy:
16+
matrix:
17+
os:
18+
- ubuntu-latest
19+
20+
php:
21+
- "8.0"
22+
23+
steps:
24+
- name: Checkout
25+
uses: actions/checkout@v2
26+
27+
- name: Install PHP
28+
uses: shivammathur/setup-php@v2
29+
with:
30+
php-version: "${{ matrix.php }}"
31+
tools: composer:v2, cs2pr
32+
coverage: none
33+
34+
- name: Determine composer cache directory
35+
run: echo "COMPOSER_CACHE_DIR=$(composer config cache-dir)" >> $GITHUB_ENV
36+
37+
- name: Cache dependencies installed with composer
38+
uses: actions/cache@v2
39+
with:
40+
path: ${{ env.COMPOSER_CACHE_DIR }}
41+
key: php${{ matrix.php }}-composer-${{ hashFiles('**/composer.json') }}
42+
restore-keys: |
43+
php${{ matrix.php }}-composer-
44+
45+
- name: Update composer
46+
run: composer self-update
47+
48+
- name: Install dependencies with composer
49+
run: composer update --prefer-dist --no-interaction --no-progress --optimize-autoloader --ansi
50+
51+
- name: Static analysis
52+
run: vendor/bin/psalm --shepherd --stats --output-format=checkstyle | cs2pr --graceful-warnings --colorize

‎.styleci.yml

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
preset: psr12
22
risky: true
33

4-
version: 8
4+
version: 7
5+
6+
finder:
7+
not-name:
8+
- "*.stub.txt"
59

610
enabled:
711
- alpha_ordered_traits
@@ -12,7 +16,6 @@ enabled:
1216
- combine_nested_dirname
1317
- declare_strict_types
1418
- dir_constant
15-
- final_static_access
1619
- fully_qualified_strict_types
1720
- function_to_constant
1821
- hash_to_slash_comment

‎LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2019 Spiral Scout
3+
Copyright (c) 2021 Spiral Scout
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎README.md

+35-57
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
1-
# CycleORM Schema renderer
1+
# Cycle ORM Schema renderer
22

3-
This package may be used to render schema roles in a terminal or generate php representation for CycleORM schema.
3+
This package may be used to render Cycle ORM Schema in a terminal or generate php representation.
4+
5+
## Installation
6+
7+
The preferred way to install this package is through [Composer](https://getcomposer.org/download/):
8+
9+
```bash
10+
composer require cycle/schema-renderer
11+
```
12+
13+
## Example
414

515
### Convert schema to array
616

@@ -11,45 +21,41 @@ $converter = new \Cycle\Schema\Renderer\SchemaToArrayConverter();
1121
$schemaArray = $converter->convert($schema);
1222
```
1323

14-
By default, SchemaToArrayConverter converts only common properties from `Cycle\ORM\SchemaInterface`.
24+
If passed `SchemaInterface` doesn't contain `toArray()` method then the `SchemaToArrayConverter` will convert
25+
only common properties from `Cycle\ORM\SchemaInterface`. Null values will be skipped also.
26+
27+
In this case Iif you want to use custom properties you can pass them to the constructor
1528

16-
But if you want to use custom properties you can pass them to the constructor
1729
```php
1830
$converter = new \Cycle\Schema\Renderer\SchemaToArrayConverter();
1931

2032
$schemaArray = $converter->convert($schema, [
21-
'my_custom_property',
22-
SchemaInterface::SOURCE,
33+
42,
34+
CustomClass::CUSTOM_PROPERTY,
2335
...
2436
]);
2537
```
2638

2739
### Render schema to a terminal
2840

2941
```php
30-
use Cycle\Schema\Renderer\ConsoleRenderer\DefaultSchemaOutputRenderer;
31-
use Cycle\Schema\Renderer\ConsoleRenderer\Formatters\StyledFormatter;
32-
use Cycle\Schema\Renderer\ConsoleRenderer\Formatters\PlainFormatter;
42+
use Cycle\Schema\Renderer\OutputSchemaRenderer;
3343

3444
$output = new \Symfony\Component\Console\Output\ConsoleOutput();
3545

36-
$formatter = new StyledFormatter(); // Colorized output
37-
// or
38-
$formatter = new PlainFormatter(); // Plain output without colors
46+
$renderer = new OutputSchemaRenderer(colorize: true);
3947

40-
$renderer = new DefaultSchemaOutputRenderer($schemaArray, $formatter);
41-
42-
foreach ($renderer as $role => $rows) {
43-
$output->writeln($rows);
44-
}
48+
$output->write($renderer->render($schemaArray));
4549
```
4650

47-
By default, DefaultSchemaOutputRenderer renders only common properties.
48-
If you want to extend default CycleORM schema you can create custom renderers and add them to the Output renderer.
51+
By default, `DefaultSchemaOutputRenderer` renders in template only common properties and relations.
52+
Custom properties will be rendered as is in separated block.
53+
If you want to extend default rendering template you can create custom renderers and add them to the Output renderer.
4954

5055
```php
5156
use Cycle\Schema\Renderer\ConsoleRenderer\Renderer;
5257
use Cycle\Schema\Renderer\ConsoleRenderer\Formatter;
58+
use Cycle\Schema\Renderer\OutputSchemaRenderer;
5359

5460
class CustomPropertyRenderer implements Renderer {
5561

@@ -65,60 +71,32 @@ class CustomPropertyRenderer implements Renderer {
6571
}
6672
}
6773

68-
$renderer = new DefaultSchemaOutputRenderer($schemaArray, $formatter);
74+
$renderer = new OutputSchemaRenderer();
6975

7076
$renderer->addRenderer(
7177
new CustomPropertyRenderer(),
7278
new PropertyRenderer('my_custom_property', 'My super property')
7379
);
7480

75-
foreach ($renderer as $role => $rows) {
76-
$output->writeln($rows);
77-
}
81+
$output->write($renderer->render($schemaArray))
7882
```
7983

8084
### Store schema in a PHP file
8185

8286
```php
83-
use Cycle\Schema\Renderer\SchemaToPhpFileRenderer;
84-
use Cycle\Schema\Renderer\PhpFileRenderer\DefaultSchemaGenerator;
87+
use Cycle\Schema\Renderer\PhpSchemaRenderer;
8588

8689
$path = __DIR__. '/schema.php'
8790

88-
$generator = new DefaultSchemaGenerator();
89-
90-
$renderer = new SchemaToPhpFileRenderer(
91-
$orm->getSchema(), $generator
92-
);
91+
$renderer = new PhpSchemaRenderer();
9392

94-
file_put_contents($path, $renderer->render());
93+
file_put_contents($path, $renderer->render($schemaArray));
9594
```
9695

97-
By default, DefaultSchemaGenerator generates only common properties.
98-
If you want to extend default CycleORM schema you can create custom generators and add them to the Output php file renderer.
96+
The Renderer generates valid PHP code, in which constants from Cycle ORM classes are substituted
97+
for better readability.
9998

99+
## License:
100100

101-
```php
102-
use Cycle\Schema\Renderer\SchemaToPhpFileRenderer;
103-
use Cycle\Schema\Renderer\PhpFileRenderer\DefaultSchemaGenerator;
104-
use Cycle\Schema\Renderer\PhpFileRenderer\Generator;
105-
use Cycle\Schema\Renderer\PhpFileRenderer\VarExporter;
106-
107-
class CustomPropertyGenerator implements Generator {
108-
109-
public function generate(array $schema, string $role): VarExporter
110-
{
111-
$key = 'my_custom_property';
112-
113-
return new VarExporter($key, $schema[$key] ?? null);
114-
}
115-
}
116-
117-
$generator = new DefaultSchemaGenerator([
118-
'my_custom_property' => new CustomPropertyGenerator()
119-
]);
120-
121-
$renderer = new SchemaToPhpFileRenderer(
122-
$orm->getSchema(), $generator
123-
);
124-
```
101+
The MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information.
102+
Maintained by [Spiral Scout](https://spiralscout.com).

‎composer.json

+35-23
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,37 @@
11
{
2-
"name": "cycle/schema-renderer",
3-
"type": "library",
4-
"license": "MIT",
5-
"description": "Utils for Cycle Schema rendering",
6-
"require": {
7-
"php": ">=7.4",
8-
"cycle/orm": "^1.5|2.0.x-dev"
9-
},
10-
"require-dev": {
11-
"phpunit/phpunit": "^9.5",
12-
"spiral/code-style": "^1.0",
13-
"vimeo/psalm": "^4.9"
14-
},
15-
"autoload": {
16-
"psr-4": {
17-
"Cycle\\Schema\\Renderer\\": "src/"
18-
}
19-
},
20-
"autoload-dev": {
21-
"psr-4": {
22-
"Cycle\\Schema\\Renderer\\Tests\\": "tests/Schema/Renderer/"
23-
}
24-
}
2+
"name": "cycle/schema-renderer",
3+
"type": "library",
4+
"license": "MIT",
5+
"description": "Utils for Cycle ORM Schema rendering",
6+
"require": {
7+
"php": ">=7.4",
8+
"cycle/orm": "1.2 - 2"
9+
},
10+
"require-dev": {
11+
"phpunit/phpunit": "^9.5",
12+
"spiral/code-style": "^1.0",
13+
"vimeo/psalm": "^4.10"
14+
},
15+
"autoload": {
16+
"psr-4": {
17+
"Cycle\\Schema\\Renderer\\": "src/"
18+
}
19+
},
20+
"autoload-dev": {
21+
"psr-4": {
22+
"Cycle\\Schema\\Renderer\\Tests\\": "tests/Schema/Renderer/"
23+
}
24+
},
25+
"scripts": {
26+
"test": [
27+
"phpcs --standard=phpcs.xml",
28+
"psalm --no-cache",
29+
"phpunit"
30+
]
31+
},
32+
"config": {
33+
"sort-packages": true
34+
},
35+
"minimum-stability": "dev",
36+
"prefer-stable": true
2537
}

‎phpcs.xml

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<?xml version="1.0"?>
2+
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Spiral Framework Code Style Ruleset">
3+
<!-- config -->
4+
<rule ref="vendor/spiral/code-style/config/ruleset.xml" />
5+
6+
<rule ref="Generic.PHP.ForbiddenFunctions">
7+
<properties>
8+
<property name="forbiddenFunctions" type="array" extend="true">
9+
<!-- deprecated/aliased functions -->
10+
<element key="join" value="implode" />
11+
<element key="chop" value="rtrim" />
12+
<element key="strchr" value="strstr" />
13+
<element key="show_source" value="highlight_file" />
14+
<element key="ini_alter" value="ini_set" />
15+
<element key="dns_check_record" value="checkdnsrr" />
16+
<element key="dns_get_mx" value="getmxrr" />
17+
<element key="doubleval" value="floatval" />
18+
<element key="is_long" value="is_int" />
19+
<element key="is_integer" value="is_int" />
20+
<element key="is_double" value="is_float" />
21+
<element key="is_real" value="is_float" />
22+
<element key="fputs" value="fwrite" />
23+
<element key="set_file_buffer" value="stream_set_write_buffer" />
24+
<element key="set_socket_blocking" value="stream_set_blocking" />
25+
<element key="socket_set_blocking" value="stream_set_blocking" />
26+
<element key="stream_register_wrapper" value="stream_wrapper_register" />
27+
<element key="socket_set_timeout" value="stream_set_timeout" />
28+
<element key="socket_get_status" value="stream_get_meta_data" />
29+
<element key="is_writeable" value="is_writable" />
30+
<element key="pos" value="current" />
31+
<element key="sizeof" value="count" />
32+
33+
<!-- deprecated/aliased operators -->
34+
<element key="delete" value="unset" />
35+
<element key="print" value="echo" />
36+
<element key="create_function" value="null" />
37+
</property>
38+
</properties>
39+
</rule>
40+
41+
<arg name="colors"/>
42+
43+
<!-- includes -->
44+
<file>./src</file>
45+
</ruleset>

‎psalm.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0"?>
22
<psalm
3-
errorLevel="3"
3+
errorLevel="2"
44
resolveFromConfigFile="true"
55
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
66
xmlns="https://getpsalm.org/schema/config"

0 commit comments

Comments
 (0)