EloquentJs\ScriptGenerator\Model\Inspector

Complexity

Total Complexity

9

Size/Duplication

Total Lines	122
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	4
Bugs	0	Features	2

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	inspect()	0	10	1
A	findEndpoint()	0	8	2
A	findDateColumns()	0	6	1
A	findScopeMethods()	0	16	2
A	findRelations()	0	6	1
A	readModelConfig()	0	6	1

<?php

namespace EloquentJs\ScriptGenerator\Model;

use Illuminate\Contracts\Config\Repository;
use Illuminate\Database\Eloquent\Model;

class Inspector
{
    /**
     * @var array
     */
    protected $excludeScopes = ['scopeScope', 'scopeEloquentJs'];

    /**
     * @var Repository
     */
    protected $config;

    /**
     * Create a new Inspector instance.
     *
     * @param Repository $config
     */
    public function __construct(Repository $config)
    {
        $this->config = $config;
    }

    /**
     * Inspect a model class and return its metadata.
     *
     * @param Model $instance
     * @return Metadata
     */
    public function inspect(Model $instance)
    {
        return new Metadata(
            class_basename($instance),
            $this->findEndpoint($instance),
            $this->findDateColumns($instance),
            $this->findScopeMethods($instance),
            $this->findRelations($instance)
        );
    }

    /**
     * Find the endpoint for this model.
     *
     * @param Model $instance
     * @return string|null
     */
    protected function findEndpoint(Model $instance)
    {
        if ($instance->getEndpoint()) {
            return $instance->getEndpoint();
        }

        return $this->readModelConfig($instance, 'endpoint');
    }

    /**
     * Get any additional date columns for this model.
     *
     * @param Model $instance
     * @return array
     */
    protected function findDateColumns(Model $instance)
    {
        return array_values(
            array_diff($instance->getDates(), ['created_at', 'updated_at', 'deleted_at'])
        );
    }

    /**
     * Get the scope methods for this model with 'scope' prefix removed.
     *
     * @param Model $instance
     * @return array
     */
    protected function findScopeMethods(Model $instance)
    {
        return array_map(
            function($method) {
                return lcfirst(substr($method, 5));
            },
            array_values(
                array_filter(
                    get_class_methods($instance),
                    function($method) {
                        return substr($method, 0, 5) === 'scope' and ! in_array($method, $this->excludeScopes);

Using logical operators such as and instead of && is generally not recommended.

                    }
                )
            )
        );
    }

    /**
     * Get a map of relation method names and their related models.
     *
     * For example, if the given model has a "comments" method that
     * describes the relation to a Comment model, this returns
     * ['comments' => 'Comment']
     *
     * @param  Model  $instance
     * @return array
     */
    protected function findRelations(Model $instance)
    {
        $relations = $this->readModelConfig($instance, 'relations', []);

        return array_map(function ($relation) { return class_basename($relation); }, $relations);
    }

    /**
     * Read from a model config value from the eloquentjs.php config file.
     *
     * @param Model $instance
     * @param string $key
     * @param mixed $default
     * @return mixed
     */
    protected function readModelConfig(Model $instance, $key, $default = null)
    {
        $className = get_class($instance);

        return $this->config->get("eloquentjs.generator.{$className}.{$key}", $default);
    }
}