Someshwer\WorldCountries\Utils\Oceans

Complexity

Total Complexity

6

Size/Duplication

Total Lines	85
Duplicated Lines	0 %

Test Coverage

Coverage

86.36%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getOptimizedOceansData()	0	6	1
A	__construct()	0	3	1
A	oceans()	0	6	1
A	optimizeOceansData()	0	7	1
A	formatOceans()	0	8	2

<?php

namespace Someshwer\WorldCountries\Utils;

use Illuminate\Encryption\Encrypter;
use Someshwer\WorldCountries\Data\DataRepository;
use Illuminate\Support\Str;

/**
 * Author: Someshwer Bandapally
 * Date: 14-07-2018.
 *
 * Provides all oceans names
 *
 * Class Oceans
 */
trait Oceans
{
    /**
     * @var DataRepository
     */
    private $data;

    /**
     * @var string
     */
    private $en_key = 'Someshwer1@2#BandapallySomeshwer';

    /**
     * @var string
     */
    private $cipher = 'AES-256-CBC';

    /**
     * Oceans constructor.
     *
     * @param DataRepository $dataRepository
     */
    public function __construct(DataRepository $dataRepository)
    {
        $this->data = $dataRepository;
    }

    /**
     * Optimize oceans data.
     *
     * @param $all_oceans_data
     *
     * @return string
     */
    private function optimizeOceansData($all_oceans_data)
    {
        $str_length = strlen($all_oceans_data) - 4;
        $all_oceans_trimmed_data = substr($all_oceans_data, 0, 2).substr($all_oceans_data, 3, $str_length);
        $hash = new Encrypter($this->en_key, $this->cipher);

        return $hash->decrypt($all_oceans_trimmed_data);
    }

    /**
     * Returns optimized oceans data.
     *
     * @return string
     */
    private function getOptimizedOceansData()
    {
        $all_oceans_data = $this->data->oceans();
        $continents_data = $this->optimizeOceansData($all_oceans_data);

        return $continents_data;
    }

    /**
     * Formats oceans data.
     *
     * @param $oceans
     *
     * @return $this
     */
    private function formatOceans($oceans)
    {
        return collect($oceans)->transform(function ($item) {

The expression return collect($oceans)->transform(function(...) { /* ... */ }) returns the type Illuminate\Support\Collection which is incompatible with the documented return type Someshwer\WorldCountries\Utils\Oceans.

            $data['name'] = $item;

$data was never initialized. Although not strictly required by PHP, it is generally a good practice to add $data = array(); before regardless.

            $data['display_name'] = Str::title($item);
            $data['also_called_as'] = ($item == 'antarctic') ? 'Southern Ocean' : null;

            return $data;
        });
    }

    /**
     * Returns all oceans names.
     *
     * @return array
     */
    public function oceans()
    {
        $oceans = $this->getOptimizedOceansData();
        $formatted_oceans = $this->formatOceans($oceans);

        return ['oceans' => $formatted_oceans];
    }
}