geocoder-php / GeocoderLaravel Testing and Mocking Setup

App\Geocoder.php

<?php

namespace App;

use Geocoder\Laravel\ProviderAndDumperAggregator as G;

class Geocoder
{
    protected $geocoder;

    public function __construct(G $geocoder)
    {
        $this->geocoder = $geocoder;
    }

    public function geocode($search)
    {
        return $this->geocoder->geocode(trim($search))->get();
    }
}

ExampleController.php

<?php

namespace App\Http\Controllers\Api;

use Illuminate\Http\Request;
use App\Http\Controllers\Controller;

use App\Geocoder;

class ExampleController extends Controller
{
    /**
     *
     * @return Response
     */
    public function __invoke(Request $request, Geocoder $geocoder)
    {
        //...
        
        $geocode = $geocoder->geocode($request->location);
        
        $geocode->first()->getCoordinates()->getLatitude();
        $geocode->first()->getCoordinates()->getLongitude();

        if (method_exists($geocode->first(), 'getFormattedAddress')) {
            $resolved_location = $geocode->first()->getFormattedAddress();
        }

        // ...
    }
}

ExampleTest.php

<?php

namespace Tests\Feature\Api;

use Tests\TestCase;
use Illuminate\Foundation\Testing\RefreshDatabase;

use Geocoder\Laravel\ProviderAndDumperAggregator as G;

class VenueSearchTest extends TestCase
{
    use RefreshDatabase;

    /**
     * Venue location search endpoint
     *
     * @return void
     */
    public function testVenueLocationSearch()
    {
        // Use the fake implementation
        $this->app->bind(\App\Geocoder::class, function () {
            return new \Tests\Mocks\Geocoder(new G());
        });

        // Hit the endpoint..
        $query = http_build_query([
            'location' => 'norwich',
        ]);

        $response = $this->getJson('/api/venue-search?' . $query);

        $response
            ->assertOk()
            ->assertJsonCount(1, 'data')
            ->assertJsonStructure([
                'data' => [],
                'links' => [],
                'meta' => [],
            ]);
    }
}

Tests\Mocks\Geocoder.php

<?php

namespace Tests\Mocks;

use Geocoder\Model\Address;
use Geocoder\Model\AddressCollection;

class Geocoder extends \App\Geocoder
{
    public function geocode($search)
    {
        return new AddressCollection([
            Address::createFromArray([
                'providedBy' => 'mock',
                'latitude' => '52.6308859',
                'longitude' => '1.297355',
                'locality' => 'Norwich',
                'postalCode' => null,
                'adminLevels' => [],
                'countryCode' => 'GB',
            ]),
        ]);

        return collect([]);
    }
}