Skip to content

Commit 8ff0a2e

Browse files
njoubert-cleveragenjoubert-cleverage
committed
Merge remote-tracking branch 'origin/prepare-release' into prepare-release
2 parents c8ceda6 + e7f865f commit 8ff0a2e

22 files changed

+447
-275
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Basically, it will greatly ease the configuration of import and exports but can
66

77
Compatible with [Symfony stable version and latest Long-Term Support (LTS) release](https://symfony.com/releases).
88

9-
Demo project can be found on [there](https://github.com/cleverage/process-bundle-ui-demo).
9+
Demo project can be found on [there](https://github.com/cleverage/process-bundle-demo).
1010

1111
## Documentation
1212

‎composer.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@
8787
"cleverage/soap-process-bundle": "Dedicated bundle for Soap dependencies for the process bundle",
8888
"cleverage/rest-process-bundle": "Dedicated bundle for Rest dependencies for the process bundle",
8989
"cleverage/flysystem-process-bundle": "Dedicated bundle for Flysystem dependencies for the process bundle",
90-
"cleverage/processuibundle": "A simple UX for cleverage/processbundle using EasyAdmin\n\n"
90+
"cleverage/ui-process-bundle": "UI for the process bundle"
9191
},
9292
"config": {
9393
"allow-plugins": {

‎config/services/logger.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ services:
2929
tags:
3030
- { name: monolog.logger, channel: cleverage_process }
3131
arguments:
32-
- '@monolog.logger'
32+
- '@logger'
3333

3434
cleverage_process.logger.task_logger:
3535
class: CleverAge\ProcessBundle\Logger\TaskLogger
3636
public: false
3737
tags:
3838
- { name: monolog.logger, channel: cleverage_process_task }
3939
arguments:
40-
- '@monolog.logger'
40+
- '@logger'

‎docs/index.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
- [CsvReaderTask](reference/tasks/csv_reader_task.md)
4545
- [CsvWriterTask](reference/tasks/csv_writer_task.md)
4646
- [CSVSplitterTask]
47-
- [InputCsvReaderTask]
47+
- [InputCsvReaderTask](reference/tasks/input_csv_reader_task.md)
4848
- File/JsonStream
4949
- [JsonStreamReaderTask]
5050
- File/XML
@@ -79,7 +79,7 @@
7979
- [ProcessLauncherTask]
8080
- Reporting
8181
- [AdvancedStatCounterTask]
82-
- [LoggerTask]
82+
- [LoggerTask](reference/tasks/logger_task.md)
8383
- [StatCounterTask]
8484
- Transformers
8585
- Basic and debug
@@ -120,10 +120,10 @@
120120
- String
121121
- [ExplodeTransformer]
122122
- [HashTransformer]
123-
- [ImplodeTransformer]
124-
- [SlugifyTransformer]
123+
- [ImplodeTransformer](reference/transformers/implode_transformer.md)
124+
- [SlugifyTransformer](reference/transformers/slugify_transformer.md)
125125
- [SprintfTransformer]
126-
- [TrimTransformer]
126+
- [TrimTransformer](reference/transformers/trim_transformer.md)
127127
- XML
128128
- [XpathEvaluatorTransformer](reference/transformers/xpath_evaluator.md)
129129
- Other bridges

‎docs/reference/tasks/constant_iterable_output_task.md‎

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -29,18 +29,12 @@ Example
2929
-------
3030

3131
```yaml
32-
clever_age_process:
33-
configurations:
34-
project_prefix.constant_iterable_output_example:
35-
tasks:
36-
constant_iterable_output_example:
37-
service: '@CleverAge\ProcessBundle\Task\ConstantIterableOutputTask'
38-
options:
39-
output:
40-
id: 123
41-
firstname: Test1
42-
lastname: Test2
43-
outputs: [debug]
44-
debug:
45-
service: '@CleverAge\ProcessBundle\Task\Debug\DebugTask'
46-
```
32+
# Task configuration level
33+
code:
34+
service: '@CleverAge\ProcessBundle\Task\ConstantIterableOutputTask'
35+
options:
36+
output:
37+
id: 123
38+
firstname: Test1
39+
lastname: Test2
40+
```

‎docs/reference/tasks/constant_output_task.md‎

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -29,18 +29,12 @@ Example
2929
-------
3030

3131
```yaml
32-
clever_age_process:
33-
configurations:
34-
project_prefix.constant_output_example:
35-
tasks:
36-
constant_output_example:
37-
service: '@CleverAge\ProcessBundle\Task\ConstantOutputTask'
38-
options:
39-
output:
40-
id: 123
41-
firstname: Test1
42-
lastname: Test2
43-
outputs: [debug]
44-
debug:
45-
service: '@CleverAge\ProcessBundle\Task\Debug\DebugTask'
46-
```
32+
# Task configuration level
33+
code:
34+
service: '@CleverAge\ProcessBundle\Task\ConstantOutputTask'
35+
options:
36+
output:
37+
id: 123
38+
firstname: Test1
39+
lastname: Test2
40+
```

‎docs/reference/tasks/counter_task.md‎

Lines changed: 7 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Task reference
1313
Accepted inputs
1414
---------------
1515

16-
`any`
16+
`any`, must implement IterableTaskInterface
1717

1818
Possible outputs
1919
----------------
@@ -31,26 +31,9 @@ Example
3131
-------
3232

3333
```yaml
34-
clever_age_process:
35-
configurations:
36-
project_prefix.counter_example:
37-
tasks:
38-
counter_example:
39-
service: '@CleverAge\ProcessBundle\Task\ConstantIterableOutputTask'
40-
options:
41-
output:
42-
test1: test1
43-
test2: test2
44-
test3: test3
45-
test4: test4
46-
test5: test5
47-
test6: test6
48-
outputs: [counter]
49-
counter:
50-
service: '@CleverAge\ProcessBundle\Task\CounterTask'
51-
options:
52-
flush_every: 2
53-
outputs: [ debug ]
54-
debug:
55-
service: '@CleverAge\ProcessBundle\Task\Debug\DebugTask'
56-
```
34+
# Task configuration level
35+
code:
36+
service: '@CleverAge\ProcessBundle\Task\CounterTask'
37+
options:
38+
flush_every: 2
39+
```

‎docs/reference/tasks/csv_reader_task.md‎

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,26 @@ Underlying method is [fgetcsv](https://secure.php.net/manual/en/function.fgetcsv
2323
Options
2424
-------
2525

26-
| Code | Type | Required | Default | Description |
27-
| ---- | ---- | :------: | ------- | ----------- |
28-
| `file_path` | `string` | **X** | | Path of the file to read from (relative to symfony root or absolute) |
29-
| `delimiter` | `string` | | `;` | CSV delimiter |
30-
| `enclosure` | `string` | | `"` | CSV enclosure character |
31-
| `escape` | `string` | | `\\` | CSV escape character |
32-
| `headers` | `array` or `null` | | `null` | Static list of CSV headers, without the option, it will be dynamically read from first input |
33-
| `mode` | `string` | | `rb` | File open mode (see [fopen mode parameter](https://secure.php.net/manual/en/function.fopen.php)) |
34-
| `log_empty_lines` | `bool` | | `false` | Log when the output is empty |
26+
| Code | Type | Required | Default | Description |
27+
|-------------------|-------------------|:---------:|----------|--------------------------------------------------------------------------------------------------|
28+
| `file_path` | `string` | **X** | | Path of the file to read from (relative to symfony root or absolute) |
29+
| `delimiter` | `string` | | `;` | CSV delimiter |
30+
| `enclosure` | `string` | | `"` | CSV enclosure character |
31+
| `escape` | `string` | | `\\` | CSV escape character |
32+
| `headers` | `array` or `null` | | `null` | Static list of CSV headers, without the option, it will be dynamically read from first input |
33+
| `mode` | `string` | | `rb` | File open mode (see [fopen mode parameter](https://secure.php.net/manual/en/function.fopen.php)) |
34+
| `log_empty_lines` | `bool` | | `false` | Log when the output is empty |
35+
36+
Example
37+
-------
38+
39+
```yaml
40+
# Task configuration level
41+
code:
42+
service: '@CleverAge\ProcessBundle\Task\File\Csv\CsvReaderTask'
43+
options:
44+
file_path: 'path/to/file.csv'
45+
delimiter: '{{ delimiter }}' ## delimiter is contextualized you must add -c delimiter:";" on console execute
46+
```
47+
48+

‎docs/reference/tasks/debug_task.md‎

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,22 +20,21 @@ Possible outputs
2020

2121
`any`: re-output given input
2222

23+
Options
24+
-------
25+
26+
None
27+
2328
Example
2429
----------------
2530

2631
```yaml
27-
clever_age_process:
28-
configurations:
29-
project_prefix.debug_example:
30-
tasks:
31-
debug_example:
32-
service: '@CleverAge\ProcessBundle\Task\ConstantOutputTask'
33-
options:
34-
output:
35-
id: 123
36-
firstname: Test1
37-
lastname: Test2
38-
outputs: [debug]
39-
debug:
40-
service: '@CleverAge\ProcessBundle\Task\Debug\DebugTask'
41-
```
32+
# Task configuration level
33+
code:
34+
service: '@CleverAge\ProcessBundle\Task\ConstantOutputTask'
35+
options:
36+
output:
37+
id: 123
38+
firstname: Test1
39+
lastname: Test2
40+
```

‎docs/reference/tasks/die_task.md‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,16 @@ Possible outputs
1919

2020
None
2121

22+
Options
23+
-------
24+
25+
None
26+
2227
Example
2328
----------------
2429

2530
```yaml
26-
clever_age_process:
27-
configurations:
28-
project_prefix.die_example:
29-
tasks:
30-
die_example:
31-
service: '@CleverAge\ProcessBundle\Task\Debug\DieTask'
32-
```
31+
# Task configuration level
32+
code:
33+
service: '@CleverAge\ProcessBundle\Task\Debug\DieTask'
34+
```

0 commit comments

Comments
 (0)