Yapeal\Sql\SqlCleanupTrait

Complexity

Total Complexity

7

Size/Duplication

Total Lines	44
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
C	getCleanedUpSql()	0	30	7

<?php
declare(strict_types = 1);
/**
 * Contains trait SqlCleanupTrait.
 *
 * PHP version 7.0+
 *
 * LICENSE:
 * This file is part of Yet Another Php Eve Api Library also know as Yapeal
 * which can be used to access the Eve Online API data and place it into a
 * database.
 * Copyright (C) 2016-2017 Michael Cummings
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see
 * <http://spdx.org/licenses/LGPL-3.0.html>.
 *
 * You should be able to find a copy of this license in the COPYING-LESSER.md
 * file. A copy of the GNU GPL should also be available in the COPYING.md file.
 *
 * @author    Michael Cummings <mgcummings@yahoo.com>
 * @copyright 2016-2017 Michael Cummings
 * @license   LGPL-3.0+
 */
namespace Yapeal\Sql;

/**
 * Trait SqlCleanupTrait.
 */
trait SqlCleanupTrait
{
    /**
     * Takes one or more SQL statements with comments and normalizes EOLs and also removes most comments.
     *
     * NOTE: Any comment 'code' like used by MySQL are also removed.
     *
     * @param string $sql
     * @param array  $sqlSubs Expects associative array with the index being what is being replaced and the value is
     *                        what it will be replaced with.
     *
     * @return string
     */
    protected function getCleanedUpSql(string $sql, array $sqlSubs): string
    {
        // Remove multi-space indents.
        do {
            $sql = str_replace("\n  ", "\n ", $sql, $count);
        } while (0 < $count);
        $sqlSubs = array_reverse($sqlSubs);
        $sqlSubs["\n)"] = ')';
        $sqlSubs["\n "] = ' ';
        $sqlSubs["\r\n"] = "\n";
        $sqlSubs = array_reverse($sqlSubs);
        // Normalize line ends and change pretty multiple lines sql and comments into single line ones
        // and do replacements.
        $sql = str_replace(array_keys($sqlSubs), array_values($sqlSubs), $sql);
        /**
         * @var string[] $lines
         */
        $lines = explode("\n", $sql);
        // Filter out non-sql lines like comments and blank lines.
        $lines = array_filter($lines,
            function ($line) {
                $line = trim($line);
                $nonSql = '' === $line
                    || 0 === strpos($line, '--')
                    || (0 === strpos($line, '/* ') && 0 === strpos(strrev($line), '/*'))
                    || (0 === strpos($line, '/** ') && 0 === strpos(strrev($line), '/*'));
                return !$nonSql;
            });
        return implode("\n", $lines);
    }
}