AutoCompletePlace::searchGazetteer() - Code Metrics - Inspection of "Use Nominatim and Openrouteservice for place autoc..." - fisharebest/webtrees - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#3706)

unknown

created 2021-02-10 16:57 UTC

AutoCompletePlace::searchGazetteer() B

↳ Parent: AutoCompletePlace

Complexity

Conditions	10
Paths	50

Size

Total Lines	61
Code Lines	39

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	10
eloc	39
nc	50
nop	1
dl	0
loc	61
rs	7.6666
c	0
b	0
f	0

How to fix Long Method Complexity

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2021 webtrees development team
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace Fisharebest\Webtrees\Http\RequestHandlers;

use Exception;
use Fisharebest\Webtrees\Gedcom;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Place;
use Fisharebest\Webtrees\Services\UserService;
use Fisharebest\Webtrees\Site;
use Fisharebest\Webtrees\Tree;
use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;
use Illuminate\Support\Collection;
use Psr\Http\Message\ServerRequestInterface;

use function assert;
use function explode;
use function json_decode;
use function json_last_error;
use function json_last_error_msg;
use function rawurlencode;
use function trim;

use const JSON_ERROR_NONE;

/**
 * Autocomplete handler for places
 */
class AutoCompletePlace extends AbstractAutocompleteHandler
{
    // Gazetteer urls
    private const NOMINATIM_URL = 'https://nominatim.openstreetmap.org/search';
    private const OPENROUTE_URL = 'https://api.openrouteservice.org/geocode/autocomplete';

    // Options for fetching files using GuzzleHTTP
    private const GUZZLE_OPTIONS = [
        'connect_timeout' => 3,
        'read_timeout'    => 3,
        'timeout'         => 3,
    ];

    protected function search(ServerRequestInterface $request): Collection
    {
        $tree = $request->getAttribute('tree');
        assert($tree instanceof Tree);

        $query = $request->getAttribute('query');

        $data = $this->search_service
            ->searchPlaces($tree, $query, 0, static::LIMIT)
            ->map(static function (Place $place): string {
                return $place->gedcomName();
            });

        if ((bool) Site::getPreference('use_gazetteer')) {
            $data = $data->concat($this->searchGazetteer($query))->unique();
            $data = $data->slice(0, static::LIMIT);
        }

        return new Collection($data);
    }

    /**
     *
     * @param string $query
     *
     * @return Collection<string>
     */
    private function searchGazetteer($query): collection
    {
        $key          = Site::getPreference('openroute_key');
        $data         = new Collection();
        $user_service = new UserService();

        if ($key === '') {
            $url   = self::NOMINATIM_URL;
            $qry = [
                'q'               => rawurlencode($query),
                'format'          => 'jsonv2',
                'limit'           => static::LIMIT,
                'accept-language' => I18N::languageTag(),
                'featuretype'     => 'settlement',
                'email'           => rawurlencode($user_service->administrators()->first()->email()),
            ];
        } else {
            $url   = self::OPENROUTE_URL;
            $qry = [
                'api_key' => $key,
                'text'    => rawurlencode($query),
                'layers'  => 'coarse',
                'size'    => static::LIMIT,
            ];
        }

        // Read from the URL
        $client = new Client();
        try {
            $json     = $client->get($url, array_merge(self::GUZZLE_OPTIONS, ['query' => $qry]))->getBody()->__toString();
            $results  = json_decode($json, false);
            if (json_last_error() !== JSON_ERROR_NONE) {
                throw new Exception(I18N::translate('Geocoder: %s', json_last_error_msg()));
            }
            if ($key === '') {
                // Use Nominatim
                foreach ($results as $result) {
                    $data->add($result->display_name);
                }
            } else {
                // Use Openroutesearch
                $place_elements = array_filter(explode(',', Site::getPreference('openroute_layers')));
                foreach ($results->features as $result) {
                    $place_parts = [];
                    foreach ($place_elements as $place_element) {
                        if (isset($result->properties->{$place_element})) {
                            $place_parts[] = $result->properties->{$place_element};
                        }
                    }
                    // If no elements are selected in the control panel
                    // or none of the selected elements are present in the place
                    // then default to the label which is always present (I think)
                    $data->add(implode(Gedcom::PLACE_SEPARATOR, $place_parts) ?: $result->properties->label);
                }
            }
        } catch (Exception | RequestException $ex) {
            // Json error? Service down?  Quota exceeded?
            $data->add($ex->getMessage());
        }

        return $data;
    }
}


1			<?php
2
3			/**
4			* webtrees: online genealogy
5			* Copyright (C) 2021 webtrees development team
6			* This program is free software: you can redistribute it and/or modify
7			* it under the terms of the GNU General Public License as published by
8			* the Free Software Foundation, either version 3 of the License, or
9			* (at your option) any later version.
10			* This program is distributed in the hope that it will be useful,
11			* but WITHOUT ANY WARRANTY; without even the implied warranty of
12			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13			* GNU General Public License for more details.
14			* You should have received a copy of the GNU General Public License
15			* along with this program. If not, see <https://www.gnu.org/licenses/>.
16			*/
17
18			declare(strict_types=1);
19
20			namespace Fisharebest\Webtrees\Http\RequestHandlers;
21
22			use Exception;
23			use Fisharebest\Webtrees\Gedcom;
24			use Fisharebest\Webtrees\I18N;
25			use Fisharebest\Webtrees\Place;
26			use Fisharebest\Webtrees\Services\UserService;
27			use Fisharebest\Webtrees\Site;
28			use Fisharebest\Webtrees\Tree;
29			use GuzzleHttp\Client;
30			use GuzzleHttp\Exception\RequestException;
31			use Illuminate\Support\Collection;
32			use Psr\Http\Message\ServerRequestInterface;
33
34			use function assert;
35			use function explode;
36			use function json_decode;
37			use function json_last_error;
38			use function json_last_error_msg;
39			use function rawurlencode;
40			use function trim;
41
42			use const JSON_ERROR_NONE;
43
44			/**
45			* Autocomplete handler for places
46			*/
47			class AutoCompletePlace extends AbstractAutocompleteHandler
48			{
49			// Gazetteer urls
50			private const NOMINATIM_URL = 'https://nominatim.openstreetmap.org/search';
51			private const OPENROUTE_URL = 'https://api.openrouteservice.org/geocode/autocomplete';
52
53			// Options for fetching files using GuzzleHTTP
54			private const GUZZLE_OPTIONS = [
55			'connect_timeout' => 3,
56			'read_timeout' => 3,
57			'timeout' => 3,
58			];
59
60			protected function search(ServerRequestInterface $request): Collection
61			{
62			$tree = $request->getAttribute('tree');
63			assert($tree instanceof Tree);
64
65			$query = $request->getAttribute('query');
66
67			$data = $this->search_service
68			->searchPlaces($tree, $query, 0, static::LIMIT)
69			->map(static function (Place $place): string {
70			return $place->gedcomName();
71			});
72
73			if ((bool) Site::getPreference('use_gazetteer')) {
74			$data = $data->concat($this->searchGazetteer($query))->unique();
75			$data = $data->slice(0, static::LIMIT);
76			}
77
78			return new Collection($data);
79			}
80
81			/**
82			*
83			* @param string $query
84			*
85			* @return Collection<string>
86			*/
87			private function searchGazetteer($query): collection
88			{
89			$key = Site::getPreference('openroute_key');
90			$data = new Collection();
91			$user_service = new UserService();
92
93			if ($key === '') {
94			$url = self::NOMINATIM_URL;
95			$qry = [
96			'q' => rawurlencode($query),
97			'format' => 'jsonv2',
98			'limit' => static::LIMIT,
99			'accept-language' => I18N::languageTag(),
100			'featuretype' => 'settlement',
101			'email' => rawurlencode($user_service->administrators()->first()->email()),
102			];
103			} else {
104			$url = self::OPENROUTE_URL;
105			$qry = [
106			'api_key' => $key,
107			'text' => rawurlencode($query),
108			'layers' => 'coarse',
109			'size' => static::LIMIT,
110			];
111			}
112
113			// Read from the URL
114			$client = new Client();
115			try {
116			$json = $client->get($url, array_merge(self::GUZZLE_OPTIONS, ['query' => $qry]))->getBody()->__toString();
117			$results = json_decode($json, false);
118			if (json_last_error() !== JSON_ERROR_NONE) {
119			throw new Exception(I18N::translate('Geocoder: %s', json_last_error_msg()));
120			}
121			if ($key === '') {
122			// Use Nominatim
123			foreach ($results as $result) {
124			$data->add($result->display_name);
125			}
126			} else {
127			// Use Openroutesearch
128			$place_elements = array_filter(explode(',', Site::getPreference('openroute_layers')));
129			foreach ($results->features as $result) {
130			$place_parts = [];
131			foreach ($place_elements as $place_element) {
132			if (isset($result->properties->{$place_element})) {
133			$place_parts[] = $result->properties->{$place_element};
134			}
135			}
136			// If no elements are selected in the control panel
137			// or none of the selected elements are present in the place
138			// then default to the label which is always present (I think)
139			$data->add(implode(Gedcom::PLACE_SEPARATOR, $place_parts) ?: $result->properties->label);
140			}
141			}
142			} catch (Exception \| RequestException $ex) {
143			// Json error? Service down? Quota exceeded?
144			$data->add($ex->getMessage());
145			}
146
147			return $data;
148			}
149			}
150

fisharebest / webtrees

Pull Request — master (#3706)

AutoCompletePlace::searchGazetteer() B

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like