Leitom\Geo\HasGeoAbilities

Complexity

Total Complexity

29

Size/Duplication

Total Lines	160
Duplicated Lines	3.75 %

Coupling/Cohesion

Components	2
Dependencies	8

Importance

Changes

0

20 Methods

Rating	Name	Duplication	Size	Complexity
A	bootHasGeoAbilities()	0	8	1
A	registerGeoMacros()	0	12	1
A	addGeo()	0	10	2
A	removeGeo()	0	10	2
A	geoImportAll()	0	6	1
A	geoRemoveAll()	0	6	1
A	geoDistanceFrom()	0	7	1
A	getGeoUnitAttribute()	0	4	1
A	getGeoDistanceAttribute()	0	8	3
A	geoEnabled()	0	4	1
A	geoIndex()	0	4	1
A	geoKeyName()	0	4	1
A	geoKey()	0	4	1
A	geoLongitude()	0	4	1
A	geoLatitude()	0	4	1
A	toCoordinate()	0	4	1
A	toArray()	0	11	2
A	databaseDriver()	0	6	1
A	scopeGeoNearest()	3	10	3
A	scopeGeoSearch()	3	10	3

<?php

namespace Leitom\Geo;

use Illuminate\Support\Arr;
use Leitom\Geo\Facades\Geo;

This use statement conflicts with another class in this namespace, Leitom\Geo\Geo.

use Illuminate\Support\Facades\DB;
use Leitom\Geo\Events\ModelsRemoved;
use Leitom\Geo\Events\ModelsImported;
use Illuminate\Support\Collection as BaseCollection;

trait HasGeoAbilities
{
    public $geoEnabled = true;

    public static function bootHasGeoAbilities()
    {
        static::addGlobalScope(new GeoScope);

        static::observe(new ModelObserver);

        (new static)->registerGeoMacros();
    }

    public function registerGeoMacros()
    {
        $self = $this;

        BaseCollection::macro('addGeo', function () use ($self) {
            $self->addGeo($this);
        });

        BaseCollection::macro('removeGeo', function () use ($self) {
            $self->removeGeo($this);
        });
    }

    public function addGeo($models)
    {
        if ($models->isEmpty()) {
            return;
        }

        Geo::index($models->first()->geoIndex())->add($models->map->toCoordinate());

        event(new ModelsImported($models));
    }

    public function removeGeo($models)
    {
        if ($models->isEmpty()) {
            return;
        }

        Geo::index($models->first()->geoIndex())->remove($models->map->geoKey()->all());

        event(new ModelsRemoved($models));
    }

    public static function geoImportAll()
    {
        $self = new static;

        $self->newQuery()->orderBy($self->geoKeyName())->addGeo();

It seems like newQuery() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    public static function geoRemoveAll()
    {
        $self = new static;

        $self->newQuery()->orderBy($self->geoKeyName())->removeGeo();

It seems like newQuery() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    public function geoDistanceFrom($model)
    {
        return [
            'unit' => $this->geoUnit,

The property geoUnit does not exist. Did you maybe forget to declare it?

            'distance' => (float) Geo::between($this->toCoordinate(), $model->toCoordinate()),
        ];
    }

    public function scopeGeoNearest($builder, $radius = 10)
    {
        $locations = array_keys(Geo::index($this->geoIndex())->from($this->toCoordinate(), $radius));

        $builder->whereIn($this->geoKeyName(), $locations);

        if ($this->databaseDriver() !== 'sqlite' && ! empty($locations)) {

This code seems to be duplicated across your project.

            $builder->orderByRaw(DB::raw(sprintf('FIELD(%s,%s)', $this->geoKeyName(), implode(',', $locations))));
        }
    }

    public function scopeGeoSearch($builder, $longitude, $latitude, $radius, $sort = 'ASC')
    {
        $locations = array_keys(Geo::index($this->geoIndex())->search($longitude, $latitude, $radius, $sort));

        $builder->whereIn($this->geoKeyName(), $locations);

        if ($this->databaseDriver() !== 'sqlite' && ! empty($locations)) {

This code seems to be duplicated across your project.

            $builder->orderByRaw(DB::raw(sprintf('FIELD(%s,%s)', $this->geoKeyName(), implode(',', $locations))));
        }
    }

    public function getGeoUnitAttribute()
    {
        return config('geo.unit');
    }

    public function getGeoDistanceAttribute()
    {
        if ($this->geoEnabled() && array_key_exists($this->geoKey(), $results = Geo::previousGeoSearch($this->geoIndex()))) {
            return Arr::get($results, $this->geoKey());
        }

        return 0;
    }

    public function geoEnabled()
    {
        return $this->geoEnabled;
    }

    public function geoIndex()
    {
        return $this->getTable();

It seems like getTable() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    public function geoKeyName()
    {
        return $this->getKeyName();

The method getKeyName() does not exist on Leitom\Geo\HasGeoAbilities. Did you maybe mean geoKeyName()?

    }

    public function geoKey()
    {
        return $this->getKey();

It seems like getKey() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    public function geoLongitude()
    {
        return $this->longitude;

The property longitude does not exist. Did you maybe forget to declare it?

    }

    public function geoLatitude()
    {
        return $this->latitude;

The property latitude does not exist. Did you maybe forget to declare it?

    }

    public function toCoordinate()
    {
        return new Coordinate($this->geoKey(), $this->geoLongitude(), $this->geoLatitude());
    }

    public function toArray()
    {
        $attributes = parent::toArray();

        if ($this->geoEnabled()) {
            $attributes['geo_unit'] = $this->geoUnit;
            $attributes['geo_distance'] = $this->geoDistance;

The property geoDistance does not exist. Did you maybe forget to declare it?

        }

        return $attributes;
    }

    protected function databaseDriver()
    {
        $connection = config('database.default');

        return config("database.connections.{$connection}.driver");
    }
}