Arcanedev\LaravelMetrics\Metrics\NullablePartition

Complexity

Total Complexity

5

Size/Duplication

Total Lines	111
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	type()	0	4	1
A	count()	0	4	1
A	aggregate()	0	23	1
A	formatAggregateResult()	0	8	1
A	result()	0	4	1

<?php

declare(strict_types=1);

namespace Arcanedev\LaravelMetrics\Metrics;

use Arcanedev\LaravelMetrics\Metrics\Concerns\HasExpressions;
use Arcanedev\LaravelMetrics\Results\PartitionResult;
use Illuminate\Support\Facades\DB;

/**
 * Class     NullablePartition
 *
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
abstract class NullablePartition extends Metric
{
    /* -----------------------------------------------------------------
     |  Traits
     | -----------------------------------------------------------------
     */

    use HasExpressions;

    /* -----------------------------------------------------------------
     |  Getters
     | -----------------------------------------------------------------
     */

    /**
     * Get the metric's type.
     *
     * @return string
     */
    public function type(): string
    {
        return 'partition';
    }

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Calculate the `count` of the metric.
     *
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $groupBy
     * @param  string|null                                   $column
     *
     * @return \Arcanedev\LaravelMetrics\Results\PartitionResult|mixed
     */
    protected function count($model, string $groupBy, $column = null)
    {
        return $this->aggregate('count', $model, $column, $groupBy);
    }

    /* -----------------------------------------------------------------
     |  Other Methods
     | -----------------------------------------------------------------
     */

    /**
     * Handle the aggregate calculation of the metric.
     *
     * @param  string                                        $method
     * @param  \Illuminate\Database\Eloquent\Builder|string  $model
     * @param  string                                        $column
     * @param  string                                        $groupBy
     *
     * @return \Arcanedev\LaravelMetrics\Results\PartitionResult|mixed
     */
    protected function aggregate(string $method, $model, ?string $column, string $groupBy)
    {
        $query         = static::getQuery($model);
        $wrappedColumn = $query->getQuery()->getGrammar()->wrap(
            $column ?? $query->getModel()->getQualifiedKeyName()

The method getQualifiedKeyName does only exist in Illuminate\Database\Eloquent\Model, but not in Illuminate\Database\Eloquent\Builder.

        );

        $groupAlias = "{$groupBy}_count";
        $expression = static::getExpression($query, 'if_null', $groupBy);

        $value = $query->select([

The method select() does not exist on Illuminate\Database\Eloquent\Builder. Did you maybe mean createSelectWithConstraint()?

            DB::raw("{$expression} as {$groupAlias}"),
            DB::raw("{$method}({$wrappedColumn}) as aggregate"),
        ])
            ->groupBy($groupAlias)
            ->get()
            ->mapWithKeys(function ($result) use ($groupAlias) {
                return $this->formatAggregateResult($result, $groupAlias);
            })
            ->all();

        return $this->result($value);
    }

    /**
     * Format the aggregate result for the partition.
     *
     * @param  \Illuminate\Database\Eloquent\Model  $result
     * @param  string                               $groupBy
     *
     * @return array
     */
    protected function formatAggregateResult($result, $groupBy): array
    {
        $key = $result->getAttribute(last(explode('.', $groupBy)));

        return [
            $key => $result->getAttribute('aggregate'),
        ];
    }

    /**
     * Make a new result instance.
     *
     * @param  mixed|null $value
     *
     * @return \Arcanedev\LaravelMetrics\Results\PartitionResult|mixed
     */
    protected function result($value = null)
    {
        return new PartitionResult($value);
    }
}