Skip to content

Use named arguments in long README pipeline examples #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pjeweb merged 1 commit into from
Sep 4, 2026
Merged

Use named arguments in long README pipeline examples #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions packages/pulp-cache/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ use OpenMapsight\PulpCache;

$source = Pulp::start()
->pipe(Pulp::srcHttp(
'GET',
'https://example.com/data.zip',
['timeout' => 120],
'data.zip'
method: 'GET',
uri: 'https://example.com/data.zip',
guzzleOptions: ['timeout' => 120],
aliasFileName: 'data.zip',
));

$files = Pulp::start()
Expand Down
24 changes: 12 additions & 12 deletions packages/pulp-datex-energy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ use OpenMapsight\PulpJSON;

$source = Pulp::start()
->pipe(PulpDatexEnergy::srcMobilithek(
$subscriptionId,
$certPath,
$certPassword,
$ifModifiedSince,
'mobilithek.json',
['timeout' => 180, 'http_errors' => false],
['sink' => true, 'successStatuses' => [200, 304]],
subscriptionId: $subscriptionId,
certPath: $certPath,
certPassword: $certPassword,
ifModifiedSince: $ifModifiedSince,
aliasFileName: 'mobilithek.json',
guzzleOptions: ['timeout' => 180, 'http_errors' => false],
options: ['sink' => true, 'successStatuses' => [200, 304]],
));

$files = Pulp::start()
Expand All @@ -51,11 +51,11 @@ $files = Pulp::start()
]))
->pipe(PulpJSON::decodeJSON())
->pipe(PulpDatexEnergy::sitesGeoJson(
[10.42, 52.18, 10.65, 52.36],
'https://example.com/open-data-docs',
'DATEX Energy',
'https://example.com/open-data-docs',
'https://example.com/open-data-docs',
bbox: [10.42, 52.18, 10.65, 52.36],
sourceUrl: 'https://example.com/open-data-docs',
sourceName: 'DATEX Energy',
documentationUrl: 'https://example.com/open-data-docs',
publicSourceUrl: 'https://example.com/open-data-docs',
))
->run();
```
Expand Down
10 changes: 5 additions & 5 deletions packages/pulp-datex-fuel/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,11 @@ $files = Pulp::start()
'fallbackToStale' => true,
]))
->pipe(PulpDatexFuel::stationsGeoJson(
[6.05, 50.76, 6.08, 50.82],
'https://example.com/open-data-docs',
'DATEX Fuel',
'https://example.com/open-data-docs',
'https://example.com/open-data-docs',
bbox: [6.05, 50.76, 6.08, 50.82],
sourceUrl: 'https://example.com/open-data-docs',
sourceName: 'DATEX Fuel',
documentationUrl: 'https://example.com/open-data-docs',
publicSourceUrl: 'https://example.com/open-data-docs',
))
->run();
```
Expand Down
34 changes: 17 additions & 17 deletions packages/pulp-datex-roadworks/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,19 +38,19 @@ use OpenMapsight\PulpJSON;

Pulp::start()
->pipe(PulpDatexRoadworks::srcMobilithek(
$subscriptionId,
$certPath,
$certPassword,
$ifModifiedSince,
'mobilithek.xml',
subscriptionId: $subscriptionId,
certPath: $certPath,
certPassword: $certPassword,
ifModifiedSince: $ifModifiedSince,
aliasFileName: 'mobilithek.xml',
))
->pipe(PulpDatexRoadworks::roadworksGeoJson(
[10.30, 52.12, 10.80, 52.42],
'https://example.com/open-data-docs',
'DATEX Roadworks',
'https://example.com/open-data-docs',
'https://example.com/open-data-docs',
['feedKind' => 'ald'],
bbox: [10.30, 52.12, 10.80, 52.42],
sourceUrl: 'https://example.com/open-data-docs',
sourceName: 'DATEX Roadworks',
documentationUrl: 'https://example.com/open-data-docs',
publicSourceUrl: 'https://example.com/open-data-docs',
options: ['feedKind' => 'ald'],
))
->pipe(PulpJSON::encodeJSON(JSON_PRETTY_PRINT))
->pipe(Pulp::dest(__DIR__ . '/result'))
Expand All @@ -66,12 +66,12 @@ already-decoded array. Records without a usable point or GML line are dropped.
use OpenMapsight\PulpDatexRoadworks;

$builder = PulpDatexRoadworks::roadworksBuilder(
[10.30, 52.12, 10.80, 52.42],
'https://example.com/open-data-docs',
'DATEX Roadworks',
'https://example.com/open-data-docs',
'https://example.com/open-data-docs',
['feedKind' => 'akd'],
bbox: [10.30, 52.12, 10.80, 52.42],
sourceUrl: 'https://example.com/open-data-docs',
sourceName: 'DATEX Roadworks',
documentationUrl: 'https://example.com/open-data-docs',
publicSourceUrl: 'https://example.com/open-data-docs',
options: ['feedKind' => 'akd'],
);

$geoJson = $builder->build($xml);
Expand Down
26 changes: 12 additions & 14 deletions packages/pulp-gtfs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,22 +42,20 @@ Pulp::start()
->pipe(Pulp::src('.*\.txt', $gtfsDirectory))
->pipe(Pulp::split(
static fn(Pulp $p): Pulp => $p->pipe(PulpGTFS::geoJson(
'stops',
'https://example.com/open-data-docs',
[10.42, 52.18, 10.65, 52.36],
null,
'GTFS',
'https://example.com/open-data-docs',
'https://example.com/open-data-docs',
type: 'stops',
sourceUrl: 'https://example.com/open-data-docs',
bbox: [10.42, 52.18, 10.65, 52.36],
sourceName: 'GTFS',
documentationUrl: 'https://example.com/open-data-docs',
publicSourceUrl: 'https://example.com/open-data-docs',
)),
static fn(Pulp $p): Pulp => $p->pipe(PulpGTFS::geoJson(
'lines',
'https://example.com/open-data-docs',
[10.42, 52.18, 10.65, 52.36],
null,
'GTFS',
'https://example.com/open-data-docs',
'https://example.com/open-data-docs',
type: 'lines',
sourceUrl: 'https://example.com/open-data-docs',
bbox: [10.42, 52.18, 10.65, 52.36],
sourceName: 'GTFS',
documentationUrl: 'https://example.com/open-data-docs',
publicSourceUrl: 'https://example.com/open-data-docs',
)),
))
->pipe(PulpGeoJSON::calculateBBoxes())
Expand Down
14 changes: 7 additions & 7 deletions packages/pulp-mobilithek/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ use OpenMapsight\PulpMobilithek;

$source = Pulp::start()
->pipe(PulpMobilithek::srcMobilithek(
$subscriptionId,
$certPath,
$certPassword,
$ifModifiedSince,
'mobilithek.xml',
['timeout' => 180, 'http_errors' => false],
['sink' => true, 'successStatuses' => [200, 304]],
subscriptionId: $subscriptionId,
certPath: $certPath,
certPassword: $certPassword,
ifModifiedSince: $ifModifiedSince,
aliasFileName: 'mobilithek.xml',
guzzleOptions: ['timeout' => 180, 'http_errors' => false],
options: ['sink' => true, 'successStatuses' => [200, 304]],
));

$files = Pulp::start()
Expand Down
10 changes: 5 additions & 5 deletions packages/pulp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,11 +103,11 @@ Creates one file from an HTTP response body.
```php
Pulp::start()
->pipe(Pulp::srcHttp(
'GET',
'https://example.com/large.json',
['timeout' => 180],
'large.json',
['sink' => true, 'successStatuses' => [200, 304, 204]]
method: 'GET',
uri: 'https://example.com/large.json',
guzzleOptions: ['timeout' => 180],
aliasFileName: 'large.json',
options: ['sink' => true, 'successStatuses' => [200, 304, 204]],
))
->run();
```
Expand Down
Loading