drupol\phpngrams\AbstractNGrams

Complexity

Total Complexity

7

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Coupling/Cohesion

Dependencies

1

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
	ngrams()	0	1	?
A	frequency()	0	13	1
A	ngramsFactory()	0	6	2
A	doNgrams()	0	14	4

<?php

declare(strict_types = 1);

namespace drupol\phpngrams;

use drupol\phpermutations\Iterators\NGrams;

This use statement conflicts with another class in this namespace, drupol\phpngrams\NGrams.

/**
 * Class AbstractNGrams
 */
abstract class AbstractNGrams implements NGramsInterface
{
    /**
     * {@inheritdoc}
     */
    abstract public function ngrams(array $data, int $n = 1);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

Avoid variables with short names like $n. Configured minimum length is 3.

    /**
     * {@inheritdoc}
     */
    public function frequency(\Generator $ngrams, array $substring)
    {
        $ngrams = iterator_to_array($ngrams);

Consider using a different name than the parameter $ngrams. This often makes code more readable.

        return count(
            array_filter(
                $ngrams,
                function ($n) use ($substring) {

Avoid variables with short names like $n. Configured minimum length is 3.

                    return $n === $substring;
                }
            )
        )/count($ngrams);
    }

    /**
     * @param array $data
     * @param int $n
     * @param bool $cyclic
     *
     * @return bool|\Generator

Consider making the return type a bit more specific; maybe use \Generator.

     */
    protected function ngramsFactory(array $data, int $n, bool $cyclic)

Avoid variables with short names like $n. Configured minimum length is 3.

    {
        foreach ($this->doNgrams($data, $n, $cyclic) as $item) {
            yield $item;
        }
    }

    /**
     * @param array $data
     * @param int $n
     * @param bool $cyclic
     *
     * @return \Generator
     */
    private function doNgrams(array $data, int $n, bool $cyclic)

Avoid variables with short names like $n. Configured minimum length is 3.

    {
        $dataLength = count($data);
        $n = $n > $dataLength ? $dataLength : $n;

Consider using a different name than the parameter $n. This often makes code more readable.

        $ngrams = new NGrams($data, $n);

        $length = (false == $cyclic ? $dataLength - $n + 1 : $dataLength);

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

        for ($j = 0; $j < $length; $j++) {
            yield array_slice($ngrams->current(), 0, $n);
            $ngrams->rewind();
        }
    }
}