Anomaly\Streams\Platform\Ui\Table\Component\Header\Guesser\HeadingsGuesser

Complexity

Total Complexity

30

Size/Duplication

Total Lines	193
Duplicated Lines	5.7 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes	6
Bugs	3	Features	1

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
F	guess()	11	140	29

<?php namespace Anomaly\Streams\Platform\Ui\Table\Component\Header\Guesser;

use Anomaly\Streams\Platform\Addon\Module\Module;
use Anomaly\Streams\Platform\Addon\Module\ModuleCollection;
use Anomaly\Streams\Platform\Stream\Contract\StreamInterface;
use Anomaly\Streams\Platform\Support\Str;
use Anomaly\Streams\Platform\Ui\Table\TableBuilder;
use Illuminate\Contracts\Config\Repository;
use Illuminate\Translation\Translator;

/**
 * Class HeadingsGuesser
 *
 * @link          http://anomaly.is/streams-platform
 * @author        AnomalyLabs, Inc. <hello@anomaly.is>
 * @author        Ryan Thompson <ryan@anomaly.is>
 * @package       Anomaly\Streams\Platform\Ui\Table\Component\Button\Guesser
 */
class HeadingsGuesser
{

    /**
     * The string utility.
     *
     * @var Str
     */
    protected $string;

    /**
     * The config repository.
     *
     * @var Repository
     */
    protected $config;

    /**
     * The module collection.
     *
     * @var ModuleCollection
     */
    protected $modules;

    /**
     * The translator utility.
     *
     * @var Translator
     */
    protected $translator;

    /**
     * Create a new HeadingsGuesser instance.
     *
     * @param Str              $string
     * @param Repository       $config
     * @param ModuleCollection $modules
     * @param Translator       $translator
     */
    public function __construct(Str $string, Repository $config, ModuleCollection $modules, Translator $translator)
    {
        $this->string     = $string;
        $this->config     = $config;
        $this->modules    = $modules;
        $this->translator = $translator;
    }

    /**
     * Guess the field for a column.
     *
     * @param TableBuilder $builder
     */
    public function guess(TableBuilder $builder)
    {
        $columns = $builder->getColumns();
        $stream  = $builder->getTableStream();

        $module = $this->modules->active();

        foreach ($columns as &$column) {

The expression $columns of type array|string is not guaranteed to be traversable. How about adding an additional type check?

            /**
             * If the heading is already set then
             * we don't have anything to do.
             */
            if (isset($column['heading'])) {
                continue;
            }

            /**
             * If the heading is false, then no
             * header is desired at all.
             */
            if (isset($column['heading']) && $column['heading'] === false) {
                continue;
            }

            /**
             * No stream means we can't
             * really do much here.
             */
            if (!$stream instanceof StreamInterface) {
                continue;
            }

            /**
             * No module means we can't
             * really do much here.
             */
            if (!$module instanceof Module) {
                continue;
            }

            if (!isset($column['field']) && is_string($column['value'])) {
                $column['field'] = $column['value'];
            }

            /**
             * If the heading matches a field
             * with dot format then reduce it.
             */
            if (isset($column['field']) && preg_match("/^entry.([a-zA-Z\\_]+)/", $column['field'], $match)) {
                $column['field'] = $match[1];
            }

            /**
             * Detect some built in columns.
             */
            if (in_array($column['field'], ['id', 'created_at', 'created_by', 'updated_at', 'updated_by'])) {

                $column['heading'] = 'streams::entry.' . $column['field'];

                continue;
            }

            /**
             * Detect entry title.
             */
            if (in_array($column['field'], ['view_link', 'edit_link']) && $field = $stream->getTitleField()) {

                $column['heading'] = $field->getName();

                continue;
            }

            $field = $stream->getField($column['value']);

            /**
             * Detect the title column.
             */
            $title = $stream->getTitleField();

            if (
                $title &&
                !$field &&
                $column['field'] == 'title' &&
                $this->translator->has($heading = $title->getName())
            ) {
                $column['heading'] = $heading;
            }

            /**
             * Use the name from the field.
             */
            if ($field && $heading = $field->getName()) {
                $column['heading'] = $heading;
            }

            /**
             * If no field look for
             * a name anyways.
             */
            if (!$field && $this->translator->has(
                    $heading = $module->getNamespace('field.' . $column['field'] . '.name')
                )
            ) {
                $column['heading'] = $heading;
            }

            /**
             * If no translatable heading yet and
             * the heading matches the value (default)
             * then humanize the heading value.
             */
            if (!isset($column['heading']) && $this->config->get('streams::locales.lazy')) {

This code seems to be duplicated across your project.

                $column['heading'] = $this->string->humanize($column['field']);
            }

            /**
             * If we have a translatable heading and
             * the heading does not have a translation
             * then humanize the heading value.
             */
            if (

This code seems to be duplicated across your project.

                isset($column['heading']) &&
                str_is('*.*.*::*', $column['heading']) &&
                !$this->translator->has($column['heading']) &&
                $this->config->get('streams::locales.lazy')
            ) {
                $column['heading'] = $this->string->humanize($column['field']);
            }

            /**
             * Last resort.
             */
            if (!isset($column['heading'])) {
                $column['heading'] = $module->getNamespace('field.' . $column['field'] . '.name');
            }
        }

        $builder->setColumns($columns);
    }
}