JsonTable\Analyse\PrimaryKey

Complexity

Total Complexity

14

Size/Duplication

Total Lines	180
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

94%

Importance

Changes	3
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	setPrimaryKeyFields()	0	4	1
A	checkColumnExistsInSchema()	0	7	2
A	csvDataForPrimaryKeyColumn()	0	5	1
A	getPrimaryKeyDataForRow()	0	10	2
A	createHash()	0	4	1
A	isHashUnique()	0	4	1
B	validate()	0	32	5
A	handleDuplicateHash()	0	9	1

<?php
namespace JsonTable\Analyse;

/**
 * Perform primary key analysis.
 *
 * @package JsonTable
 */
class PrimaryKey extends Analyse implements AnalyseInterface
{
    /**
     * @var string The description for fields with duplicated primary keys.
     */
    const ERROR_DUPLICATE_PRIMARY_KEY = 'There are <strong>%d</strong> rows that have duplicated primary keys:';

    /**
     * @var array   The current CSV row being analysed.
     */
    private $currentCsvRow;

    /**
     * @var int The position of the current CSV row row in the CSV file.
     */
    private $rowNumber;

    /**
     * @var array   The primary keys for every row in the file.
     */
    private $fileKeys;

    /**
     * @var array   The primary key parts for the current row.
     */
    private $rowKeyParts;

    /**
     * @var array   The primary key fields.
     */
    private $primaryKeyFields;

    /**
     * @var string  The name of the primary key field currently being analysed.
     */
    private $primaryKeyFieldName;

    /**
     * @var string  The hash of the data taken from the primary key fields in the current CSV row.
     */
    private $hash;


    /**
     * Validate that any specified primary key constraints have been met.
     *
     * @return  boolean Does the data meet the primary key constraints.
     *
     *
     */
    public function validate()
    {
        if (false === property_exists(parent::$schemaJson, 'primaryKey')) {
            return true;
        }

        $this->setPrimaryKeyFields();
        $this->fileKeys = [];

        self::rewindFilePointerToFirstData();

        $this->rowNumber= 1;

        while ($currentCsvRow = parent::loopThroughFileRows()) {
            $this->currentCsvRow = $currentCsvRow;
            $this->getPrimaryKeyDataForRow();
            $this->createHash();

            if ($existingKey = $this->isHashUnique()) {
                $this->handleDuplicateHash($existingKey);

                if ($this->stopIfInvalid) {
                    return false;
                }
            }

            $this->fileKeys[$this->rowNumber] = $this->hash;
            $this->rowNumber++;
        }

        return true;
    }


    /**
     * Set the primary key fields.
     *
     * @return  void
     */
    private function setPrimaryKeyFields()
    {
        $this->primaryKeyFields = (array) parent::$schemaJson->primaryKey;
    }


    /**
     * Check that there is a column in the JSON table schema file for the current primary key field.
     *
     * @return  void
     *
     * @throws  \Exception if the primary key was not in the schema file.
     */
    private function checkColumnExistsInSchema()
    {
        if (false === $this->getSchemaKeyFromName($this->primaryKeyFieldName)) {
            throw new \Exception("The primary key &quot;$this->primaryKeyFieldName&quot; was not in the file.
                    Primary key columns should be set as required.");
        }
    }


    /**
     * Get the data in the CSV column for the current primary key column.
     *
     * @return  string  The data in the column.
     */
    private function csvDataForPrimaryKeyColumn()
    {
        $csvPosition = $this->getCsvPositionFromName($this->primaryKeyFieldName);
        return $this->currentCsvRow[$csvPosition];
    }


    /**
     * Get the data in the primary key columns for the current CSV row.
     *
     * @return  void
     */
    private function getPrimaryKeyDataForRow()
    {
        $this->rowKeyParts = [];

        foreach ($this->primaryKeyFields as $fieldName) {
            $this->primaryKeyFieldName = strtolower($fieldName);
            $this->checkColumnExistsInSchema();
            $this->rowKeyParts[] = $this->csvDataForPrimaryKeyColumn();
        }
    }


    /**
     * Create a hash of the data taken from the primary key fields in the current CSV row.
     *
     * @return  void
     */
    private function createHash()
    {
        $this->hash = implode(', ', $this->rowKeyParts);
    }


    /**
     * Check whether the current hash has already been created for this file.
     *
     * @return  boolean|int False if this row's primary key hash is unique
     *                      or the number of the row with the same hash if it's not.
     */
    private function isHashUnique()
    {
        return array_search($this->hash, $this->fileKeys);
    }


    /**
     * Handle the current hash not being unique.
     *
     * @param   int $existingKey    The number of the row with the same hash.
     *
     * @return  void
     */
    private function handleDuplicateHash($existingKey)
    {
        $primaryKeyColumns = implode(', ', $this->primaryKeyFields);
        $errorMessage = "The data in columns &quot;$primaryKeyColumns&quot; should be unique,
                but rows $existingKey &amp; $this->rowNumber have the same values of &quot;$this->hash&quot;";

        $this->error->setError(self::ERROR_DUPLICATE_PRIMARY_KEY, $errorMessage);
        $this->statistics->setErrorRow($this->rowNumber);
    }
}