8000 Add Faker provider · geocoder-php/Geocoder@4c890fe · GitHub
[go: up one dir, main page]
Skip to content

Commit 4c890fe

Browse files
ker0xker0x
committed
Add Faker provider
1 parent 9c2224f commit 4c890fe

File tree

19 files changed

+348
-10
lines changed

19 files changed

+348
-10
lines changed

‎.github/workflows/provider.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ jobs:
2121
- BingMaps
2222
- Cache
2323
- Chain
24+
- Faker
2425
- FreeGeoIp
2526
- GeoIP2
2627
# - GeoIPs

‎README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -112,10 +112,11 @@ and are highly configurable.
112112

113113
### Special providers
114114

115-
Provider | Package | Features | Stats
116-
:------------- |:------- |:-------- |:-------
117-
[Cache](https://github.com/geocoder-php/cache-provider) | `geocoder-php/cache-provider` | Wraps a provider and cached the results | [![Latest Stable Version](https://poser.pugx.org/geocoder-php/cache-provider/v/stable)](https://packagist.org/packages/geocoder-php/cache-provider) <br>[![Total Downloads](https://poser.pugx.org/geocoder-php/cache-provider/downloads)](https://packagist.org/packages/geocoder-php/cache-provider)
118-
[Chain](https://github.com/geocoder-php/chain-provider) | `geocoder-php/chain-provider` | Iterates over multiple providers | [![Latest Stable Version](https://poser.pugx.org/geocoder-php/chain-provider/v/stable)](https://packagist.org/packages/geocoder-php/chain-provider) <br>[![Total Downloads](https://poser.pugx.org/geocoder-php/chain-provider/downloads)](https://packagist.org/packages/geocoder-php/chain-provider)
115+
Provider | Package | Features | Stats
116+
:------------- |:------------------------------|:----------------------------------------------------------------|:-------
117+
[Cache](https://github.com/geocoder-php/cache-provider) | `geocoder-php/cache-provider` | Wraps a provider and cached the results | [![Latest Stable Version](https://poser.pugx.org/geocoder-php/cache-provider/v/stable)](https://packagist.org/packages/geocoder-php/cache-provider) <br>[![Total Downloads](https://poser.pugx.org/geocoder-php/cache-provider/do 32D8 wnloads)](https://packagist.org/packages/geocoder-php/cache-provider)
118+
[Chain](https://github.com/geocoder-php/chain-provider) | `geocoder-php/chain-provider` | Iterates over multiple providers | [![Latest Stable Version](https://poser.pugx.org/geocoder-php/chain-provider/v/stable)](https://packagist.org/packages/geocoder-php/chain-provider) <br>[![Total Downloads](https://poser.pugx.org/geocoder-php/chain-provider/downloads)](https://packagist.org/packages/geocoder-php/chain-provider)
119+
[Faker](https://github.com/geocoder-php/faker-provider) | `geocoder-php/faker-provider` | Provide fake data using [FakerPHP](https://fakerphp.github.io/) | [![Latest Stable Version](https://poser.pugx.org/geocoder-php/faker-provider/v/stable)](https://packagist.org/packages/geocoder-php/faker-provider) <br>[![Total Downloads](https://poser.pugx.org/geocoder-php/faker-provider/downloads)](https://packagist.org/packages/geocoder-php/faker-provider)
119120

120121
### Address
121122

@@ -218,6 +219,11 @@ var_export($result);
218219

219220
Everything is ok, enjoy!
220221

222+
### The Faker Provider
223+
224+
The `Faker` provider is a special provider that return fake data using [FakerPHP](https://fakerphp.github.io/).
225+
It's main purpose is to provide fake data during tests, avoiding unnecessary http requests.
226+
221227
### The ProviderAggregator
222228

223229
The `ProviderAggregator` is used to register several providers so that you can

‎composer.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
"cache/array-adapter": "^1.0",
3131
"cache/simple-cache-bridge": "^1.0",
3232
"cache/void-adapter": "^1.0",
33+
"fakerphp/faker": "^1.23",
3334
"geocoder-php/provider-integration-tests": "^1.6.3",
3435
"geoip2/geoip2": "~2.0",
3536
"nyholm/nsa": "^1.1",

‎src/Common/Geocoder.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,14 @@ interface Geocoder extends Provider
3434
/**
3535
* Geocodes a given value.
3636
*
37-
* @throws \Geocoder\Exception\Exception
37+
* @throws Exception\Exception
3838
*/
3939
public function geocode(string $value): Collection;
4040

4141
/**
4242
* Reverses geocode given latitude and longitude values.
4343
*
44-
* @throws \Geocoder\Exception\Exception
44+
* @throws Exception\Exception
4545
*/
4646
public function reverse(float $latitude, float $longitude): Collection;
4747
}

‎src/Provider/AzureMaps/Tests/IntegrationTest.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ class IntegrationTest extends ProviderIntegrationTest
1818
];
1919

2020
/**
21-
* @return \Geocoder\Provider\Provider that is used in the tests
21+
* @return Geocoder\Provider\Provider that is used in the tests
2222
*/
2323
protected function createProvider(ClientInterface $httpClient)
2424
{
25-
return new \Geocoder\Provider\AzureMaps\AzureMaps($httpClient, $_SERVER['AZURE_MAPS_SUBSCRIPTION_KEY']);
25+
return new Geocoder\Provider\AzureMaps\AzureMaps($httpClient, $_SERVER['AZURE_MAPS_SUBSCRIPTION_KEY']);
2626
}
2727

2828
/**

‎src/Provider/Faker/.gitattributes

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.gitattributes export-ignore
2+
phpunit.xml.dist export-ignore
3+
Tests/ export-ignore

‎src/Provider/Faker/.github/workflows/provider.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Provider
2+
3+
on:
4+
push:
5+
branches: [ master ]
6+
pull_request:
7+
branches: [ master ]
8+
9+
jobs:
10+
test:
11+
name: PHP ${{ matrix.php-version }}
12+
runs-on: ubuntu-latest
13+
strategy:
14+
fail-fast: false
15+
matrix:
16+
php-version: ['8.0', '8.1', '8.2']
17+
steps:
18+
- uses: actions/checkout@v3
19+
- name: Use PHP ${{ matrix.php-version }}
20+
uses: shivammathur/setup-php@v2
21+
with:
22+
php-version: ${{ matrix.php-version }}
23+
extensions: curl
24+
- name: Validate composer.json and composer.lock
25+
run: composer validate --strict
26+
- name: Install dependencies
27+
run: composer update --prefer-stable --prefer-dist --no-progress
28+
- name: Run test suite
29+
run: composer run-script test-ci
30+
- name: Upload Coverage report
31+
run: |
32+
wget https://scrutinizer-ci.com/ocular.phar
33+
php ocular.phar code-coverage:upload --format=php-clover build/coverage.xml

‎src/Provider/Faker/.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
vendor/
2+
composer.lock
3+
.phpunit.result.cache

‎src/Provider/Faker/CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Change Log
2+
3+
The change log describes what is "Added", "Removed", "Changed" or "Fixed" between each release.
4+
5+
## 5.0.0
6+
7+
First release of this library.

‎src/Provider/Faker/Faker.php

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Geocoder\Provider\Faker;
6+
7+
use Faker\Factory;
8+
use Geocoder\Collection;
9+
use Geocoder\Model\AddressBuilder;
10+
use Geocoder\Model\AddressCollection;
11+
use Geocoder\Provider\Provider;
12+
use Geocoder\Query\GeocodeQuery;
13+
use Geocoder\Query\Query;
14+
use Geocoder\Query\ReverseQuery;
15+
16+
/**
17+
* @author Romain Monteil <monteil.romain@gmail.com>
18+
*/
19+
final class Faker implements Provider
20+
{
21+
public const PROVIDER_NAME = 'faker';
22+
23+
public function geocodeQuery(GeocodeQuery $query): Collection
24+
{
25+
return $this->generateFakeLocations($query);
26+
}
27+
28+
public function reverseQuery(ReverseQuery $query): Collection
29+
{
30+
return $this->generateFakeLocations($query);
31+
}
32+
33+
public function getName(): string
34+
{
35+
return self::PROVIDER_NAME;
36+
}
37+
38+
private function generateFakeLocations(Query $query): Collection
39+
{
40+
$faker = Factory::create($query->getLocale() ?? Factory::DEFAULT_LOCALE);
41+
42+
$results = [];
43+
44+
$i = 0;
45+
while ($i < $query->getLimit()) {
46+
$builder = new AddressBuilder($this->getName());
47+
$builder
48+
->setCoordinates($faker->latitude(), $faker->longitude())
49+
->setStreetNumber($faker->buildingNumber())
50+
->setStreetName($faker->streetName())
51+
->setPostalCode($faker->postcode())
52+
->setLocality($faker->city())
53+
->setCountry($faker->country())
54+
->setCountryCode($faker->countryCode())
55+
->setTimezone($faker->timezone())
56+
;
57+
58+
$results[] = $builder->build();
59+
++$i;
60+
}
61+
62+
return new AddressCollection($results);
63+
}
64+
}

0 commit comments

Comments
 (0)
0