samsonos / php_compressor

src/Code.php

<?php
/**
 * Created by PhpStorm.
 * User: egorov
 * Date: 09.02.2015
 * Time: 16:20
 */
namespace samsonphp\compressor;
use samson\core\Module;

/**
 * Code compressor.
 * @package samsonphp\compressor
 */
class Code implements CompressibleInterface
{
    /** Code excluding markers */
    const EXCLUDE_ST = '\/\/\[PHPCOMPRESSOR\(remove\,start\)\]';
    const EXCLUDE_EN = '\/\/\[PHPCOMPRESSOR\(remove\,end\)\]';

    /** Use statement pattern */
    const PAT_USE = '/\s*use\s+(?<class>[^ ]+)(\s+as\s+(<alias>[^;]+))*;/iu';
    /** Blank lines pattern */
    const PAT_BLANK_LINES = '/(^[\r\n]*|[\r\n]+)[\s\t]*[\r\n]+/';

    /** @var array Collection of files that has been compressed */
    protected $files = array();

    /** @var array Collection of  NameSpace => \samsonphp\compressor\NS */
    protected $data = array();

    /** @var  Object Logger object */
    protected $logger;

    /**
     * Remove blank lines from code
     * http://stackoverflow.com/questions/709669/how-do-i-remove-blank-lines-from-text-in-php
     * @param string $code Code for removing blank lines
     * @return string Modified code
     */
    protected function removeBlankLines($code)
    {
        // New line is required to split non-blank lines
        return preg_replace(self::PAT_BLANK_LINES, "\n", $code);
    }

    /**
     * @param \samson\core\Module $module Module which code is being gathered

There is no parameter named $module. Was it maybe removed?

     */
    public function __construct(array $files, $logger = null)
    {
        $this->logger = & $logger;

        // Gather all module code resource files
        foreach ($files as $file) {
            // Compress this files into code array
            $this->compress($file);

The call to compress() misses a required argument $output.

        }
    }

    /**
     * Remove all use statements in a file and replace class/function calls
     * to full syntax names.
     */
    public function removeUSE($code)
    {
        // Find all uses in file
        $matches = array();
        if (preg_match_all(self::PAT_USE, $code, $matches)) {
            for ($i = 0,$size = sizeof($matches[1]); $i < $size; $i++) {
                // Get full class name
                $fullClassName = $matches['class'][$i];

                // Get class name without namespace
                $className = substr(strrchr($fullClassName, '\\'), 1);

                // Prepend global namespace sign
                $fullClassName = $fullClassName{0} !== '\\' ? '\\'.$fullClassName : $fullClassName;

                // Determine marker in code for this use, alias or just class name
                $replace = isset($matches['alias'][$i]{0}) ?
                    $matches['alias'][$i] : // Use alias name
                    $className; // Use class name without namespace

                // Remove use statement
                $code = str_replace($matches[0][$i], '', $code);

                // Check class existence
                if (class_exists($fullClassName) || interface_exists($fullClassName)) {

Blank line found at start of control structure

                    $this->logger->log(' Removing USE statement for [##]', $fullClassName);

                    // Replace class static call
                    $code = preg_replace(
                        '/([^\\\a-z])' . $replace . '::/i',
                        '$1' . $fullClassName . '::',
                        $code
                    );

                    // Replace class implements calls
                    $code = preg_replace(
                        '/implements\s+(.*)' . $replace . '/i',
                        'implements $1' . $fullClassName,
                        $code
                    );

                    // Replace class extends calls
                    $code = preg_replace(
                        '/extends\s+' . $replace . '/i',
                        'extends ' . $fullClassName,
                        $code
                    );

                    // Replace class hint calls
                    $code = preg_replace(
                        '/(\(|\s|\,)\s*' . $replace . '\s*(&|$)/i',
                        '$1' . $fullClassName . ' $2',
                        $code
                    );

                    // Replace class creation call
                    $code = preg_replace(
                        '/new\s+' . $replace . '\s*\(/i',
                        'new ' . $fullClassName . '(',
                        $code
                    );

Blank line found at end of control structure

                } else {
                    $this->logger->log(
                        'Cannot remove use statement[##] - Class or interface does not exists',
                        $matches[0][$i]
                    );
                }
            }
        }

        return $code;
    }

    /**
     * Remove excluded code blocks
     * @param string $code Code to exclude
     * @return string Code cleared from excluded blocks
     */
    public function removeExcluded($code)
    {
        // Remove excluded code blocks
        return preg_replace('/'.self::EXCLUDE_ST.'.*?'.self::EXCLUDE_EN.'/uis', '', $code);
    }

    public function compress($file, $output)
    {
        if (file_exists($file)) {
            // Make full real path to file
            $file = realpath($file);
            // If we have not processed this file yet
            if (!in_array($file, $this->files)) {
                $this->files[] = $file;

                $this->logger->log('Compressing PHP code file[##]', $file);

                // Read and compress file contents
                $this->data[$file] = $this->removeUSE(
                    $this->removeExcluded(
                        $this->removeBlankLines(
                            file_get_contents($file)
                        )
                    )
                );

Blank line found at end of control structure

            } else {
                $this->logger->log('PHP code file[##] already compressed', $file);
            }
        } else {
            $this->logger->log('PHP code file[##] does not exists', $file);
        }
    }

    /**
     * Reccurent PHP code parser
     *
     * @param string $path Abcolute path to php file
     * @param Module  $module Pointer to file owning module object
     * @param array  $code Collection where we need to gather parsed PHP code
     * @param string $namespace Module namespace
     *
     * @return array
     */
    protected function parse( $path, $module = NULL, & $code = array(), $namespace = self::NS_GLOBAL )

TRUE, FALSE and NULL must be lowercase; expected null, but found NULL.

Expected 0 spaces between opening bracket and argument "$path"; 1 found

Expected 0 spaces between argument "$namespace" and closing bracket; 1 found

    {
        $_path = $path;
        $path = normalizepath(realpath($path));

        // Если мы уже подключили данный файл или он не существует
        if( isset( $this->files[ $path ])  ) 	return $this->log('    ! Файл: [##], already compressed', $path);

The method log() does not seem to exist on object<samsonphp\compressor\Code>.

This code seems to be duplicated across your project.

It is generally a best practice to always use braces with control structures.

Expected 0 spaces before closing bracket; 2 found

Expected 1 space after IF keyword; 0 found

        else if( !is_file($path) )				return $this->log('    ! Файл: [##], не существует', $_path );

The method log() does not seem to exist on object<samsonphp\compressor\Code>.

It is generally a best practice to always use braces with control structures.

Expected 0 spaces before closing bracket; 1 found

Expected 1 space after IF keyword; 0 found

        else if(strpos($path, 'vendor/autoload.php') !== false) return $this->log('    Ignoring composer autoloader [##]', $path);

The method log() does not seem to exist on object<samsonphp\compressor\Code>.

It is generally a best practice to always use braces with control structures.

Expected 1 space after IF keyword; 0 found

        else if(in_array(basename($path), $this->ignoredFiles)) { return $this->log('    Ignoring file[##] by configuration', $path);}

The property ignoredFiles does not exist. Did you maybe forget to declare it?

The method log() does not seem to exist on object<samsonphp\compressor\Code>.

Expected 1 space after IF keyword; 0 found

        $this->log(' - Parsing file [##]', $path);

The method log() does not seem to exist on object<samsonphp\compressor\Code>.

        // Load file once, if it's not have been loaded before
        require_once($path);

        // Сохраним файл
        $this->files[ $path ] = $path;

        // Прочитаем php файл
        $fileStr = file_get_contents( $path );

        $main_code = "\n".'// Модуль: '.m($module)->id().', файл: '.$path."\n";

The function m() has been deprecated with message: Use $this->system->module() in module context

        // Создадим уникальную коллекцию алиасов для NS
        if( !isset($code[ $namespace ][ 'uses' ] ) ) $code[ $namespace ][ 'uses' ] = array();

It is generally a best practice to always use braces with control structures.

Expected 1 space after IF keyword; 0 found

        // Установим ссылку на коллекцию алиасов
        $uses = & $code[ $namespace ][ 'uses' ];

        // Local file uses collection
        $file_uses = array();

        // Получим константы документа
        $consts = get_defined_constants();

        // Маркеры для отрезания специальных блоков которые не нужны в PRODUCTION
        $rmarker_st = '\/\/\[PHPCOMPRESSOR\(remove\,start\)\]';
        $rmarker_en = '\/\/\[PHPCOMPRESSOR\(remove\,end\)\]';

        // Найдем все "ненужные" блоки кода и уберем их
        $fileStr = preg_replace('/'.$rmarker_st.'.*?'.$rmarker_en.'/uis', '', $fileStr );

        // Разберем код программы
        $tokens = token_get_all($fileStr);
        for ($i = 0; $i < sizeof($tokens); $i++)

It seems like you are calling the size function sizeof() as part of the test condition. You might want to compute the size beforehand, and not on each iteration.

        {
            // Получим следующий жетон из кода программы
            $token = $tokens[$i];

            // Если просто строка
            if ( is_string( $token ) ) $main_code .= $token;

It is generally a best practice to always use braces with control structures.

            // Если это специальный жетон
            else

Expected 1 space after ELSE keyword; newline found

            {
                // token array
                list( $id, $text ) = $token;

                // Перебирем тип комманды
                switch ($id)
                {
                    case T_COMMENT: // Пропускаем все комментарии
                    case T_DOC_COMMENT:
                    case T_CLOSE_TAG: // Начало,конец файла
                    case T_OPEN_TAG: break;

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

                    case T_WHITESPACE:	$main_code .= $text; /*$main_code .= ' ';*/ break;

It is generally recommended to place each PHP statement on a line by itself.

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

                    // Обработаем алиасы
                    case T_USE:

The case body in a switch statement must start on the line following the statement.

                        $_use = '';

                        // Переберем все что иде после комманды алиаса
                        for ($j = $i+1; $j < sizeof($tokens); $j++)

It seems like you are calling the size function sizeof() as part of the test condition. You might want to compute the size beforehand, and not on each iteration.

                        {
                            // Получим идентификатор метки и текстовое представление
                            $id = isset( $tokens[ $j ][0] ) ? $tokens[ $j ][0] : '';
                            $text = isset( $tokens[ $j ][1] ) ? $tokens[ $j ][1] : '';

                            //trace('"'.$id.'" - "'.$text.'"');

                            // Если use используется в функции
                            if( $id == '(' ) { $j--; break; }

It is generally recommended to place each PHP statement on a line by itself.

Expected 0 spaces before closing bracket; 1 found

Expected 1 space after IF keyword; 0 found

                            // Если это закрывающая скобка - прекратим собирание пути к файлу
                            if( $id == ';' ) break;

It is generally a best practice to always use braces with control structures.

Expected 0 spaces before closing bracket; 1 found

Expected 1 space after IF keyword; 0 found

                            // Все пробелы игнорирую
                            if( $id == T_WHITESPACE ) continue;

It is generally a best practice to always use braces with control structures.

Expected 0 spaces before closing bracket; 1 found

Expected 1 space after IF keyword; 0 found

                            // Если у метки есть текстовое представление
                            if( isset( $text ) )

Expected 1 space after IF keyword; 0 found

                            {
                                // Если єто константа
                                if( isset( $consts[ $text ])) $_use .= $consts[ $text ];

It is generally a best practice to always use braces with control structures.

Expected 1 space after IF keyword; 0 found

                                // Если это путь
                                else $_use .= $text;

It is generally a best practice to always use braces with control structures.

                            }
                        }

                        // Если это не use в inline функции - добавим алиас в коллекцию
                        // для данного ns с проверкой на уникальность
                        if( $id !== '(' )

Expected 0 spaces before closing bracket; 1 found

Expected 1 space after IF keyword; 0 found

                        {
                            // Нижний регистр
                            //$_use = strtolower($_use);

                            // Преведем все use к одному виду
                            if( $_use{0} !== '\\') $_use = '\\'.$_use;

It is generally a best practice to always use braces with control structures.

Expected 1 space after IF keyword; 0 found

                            // Add local file uses
                            $file_uses[] = $_use;

                            // TODO: Вывести замечание что бы код везде был одинаковый
                            if( !in_array( $_use, $uses ) )

Expected 1 space after IF keyword; 0 found

                            {

Blank line found at start of control structure

                                $uses[] = $_use;
                            }
                        } else {
                            $main_code .= ' use ';
                        }

                        // Сместим указатель чтения файла
                        $i = $j;

                        break;

                    case T_NAMESPACE:

This code seems to be duplicated across your project.

The case body in a switch statement must start on the line following the statement.

                        // Определим временное пространство имен
                        $_namespace = '';

                        // Переберем все что иде после комманды подключения файла
                        for ($j = $i+1; $j < sizeof($tokens); $j++)

It seems like you are calling the size function sizeof() as part of the test condition. You might want to compute the size beforehand, and not on each iteration.

                        {
                            // Получим идентификатор метки и текстовое представление
                            $id = isset( $tokens[ $j ][0] ) ? $tokens[ $j ][0] : '';
                            $text = isset( $tokens[ $j ][1] ) ? $tokens[ $j ][1] : '';

                            //trace('"'.$id.'" - "'.$text.'"');

                            // Если это закрывающая скобка - прекратим собирание пути к файлу
                            if( $id == ')' || $id == ';' ||  $id == '{' ) break;

It is generally a best practice to always use braces with control structures.

Expected 0 spaces before closing bracket; 1 found

Expected 1 space after IF keyword; 0 found

                            // Все пробелы игнорирую
                            if( $id == T_WHITESPACE ) continue;

It is generally a best practice to always use braces with control structures.

Expected 0 spaces before closing bracket; 1 found

Expected 1 space after IF keyword; 0 found

                            // Если у метки есть текстовое представление
                            if( isset( $text ) )

Expected 1 space after IF keyword; 0 found

                            {
                                // Если єто константа
                                if( isset( $consts[ $text ])) $_namespace .= $consts[ $text ];

It is generally a best practice to always use braces with control structures.

Expected 1 space after IF keyword; 0 found

                                // Если это путь
                                else $_namespace .= $text;

It is generally a best practice to always use braces with control structures.

                            }
                        }

                        // Если найденный NS отличается от текущего - установим переход к новому NS
                        if( $namespace !== $_namespace )

Expected 0 spaces before closing bracket; 1 found

Expected 1 space after IF keyword; 0 found

                        {
                            // Сохраним новый как текущий
                            $namespace = strtolower($_namespace);

                            //trace('               #'.$i.' -> Изменили NS с '.$namespace.' на '.$_namespace);

                            // Если мы еще не создали данный NS
                            if( !isset($code[ $namespace ]) ) $code[ $namespace ] = array();

It is generally a best practice to always use braces with control structures.

Expected 0 spaces before closing bracket; 1 found

Expected 1 space after IF keyword; 0 found

                            // Создадим уникальную коллекцию алиасов для NS
                            if( !isset($code[ $namespace ][ 'uses' ] ) ) $code[ $namespace ][ 'uses' ] = array();

It is generally a best practice to always use braces with control structures.

Expected 1 space after IF keyword; 0 found

                            // Установим ссылку на коллекцию алиасов
                            $uses = & $code[ $namespace ][ 'uses' ];
                        }

                        // Сместим указатель чтения файла
                        $i = $j;

                        break;

                    // Выделяем код подключаемых файлов
                    case T_REQUIRE :

There must be no space before the colon in a CASE statement

                    case T_REQUIRE_ONCE :

There must be no space before the colon in a CASE statement

                        //case T_INCLUDE :
                    case T_INCLUDE_ONCE:

This code seems to be duplicated across your project.

case statements should be defined using a colon.

                    {
                        // Получим путь к подключаемому файлу
                        $file_path = '';

                        // Переберем все что иде после комманды подключения файла
                        for ($j = $i+1; $j < sizeof($tokens); $j++)

It seems like you are calling the size function sizeof() as part of the test condition. You might want to compute the size beforehand, and not on each iteration.

                        {
                            // Получим идентификатор метки и текстовое представление
                            $id = isset( $tokens[ $j ][0] ) ? $tokens[ $j ][0] : '';
                            $text = isset( $tokens[ $j ][1] ) ? $tokens[ $j ][1] : '';

                            //trace('"'.$id.'" - "'.$text.'"');

                            // Если это закрывающая скобка - прекратим собирание пути к файлу
                            if( $id == ';' ) break;

It is generally a best practice to always use braces with control structures.

Expected 0 spaces before closing bracket; 1 found

Expected 1 space after IF keyword; 0 found

                            // Все пробелы игнорирую
                            if( $id == T_WHITESPACE ) continue;

It is generally a best practice to always use braces with control structures.

Expected 0 spaces before closing bracket; 1 found

Expected 1 space after IF keyword; 0 found

                            // Если у метки есть текстовое представление
                            if( isset( $text ) )

Expected 1 space after IF keyword; 0 found

                            {
                                // Если єто константа
                                if( isset( $consts[ $text ])) $file_path .= $consts[ $text ];

It is generally a best practice to always use braces with control structures.

Expected 1 space after IF keyword; 0 found

                                // Если это путь
                                else $file_path .= $text;

It is generally a best practice to always use braces with control structures.

                            }
                        }

                        // Если указан путь к файлу
                        if( isset($file_path{1}) )

Expected 0 spaces before closing bracket; 1 found

Expected 1 space after IF keyword; 0 found

                        {
                            // Уберем ковычки
                            $file_path = str_replace(array("'",'"'), array('',''), $file_path );

                            // Если это не абсолютный путь - попробуем относительный
                            if( !file_exists( $file_path ) ) $file_path = pathname($path).$file_path;

It is generally a best practice to always use braces with control structures.

Expected 1 space after IF keyword; 0 found

                            // Если файл найден - получим его содержимое
                            if( file_exists( $file_path ) )

Expected 1 space after IF keyword; 0 found

                            {
                                //trace('Углубляемся в файл:'.$file_path.'('.$namespace.')');

                                // Углубимся в рекурсию
                                $this->compress_php( $file_path, $module, $code, $namespace );

The method compress_php() does not exist on samsonphp\compressor\Code. Did you maybe mean compress()?

                                // Измением позицию маркера чтения файла
                                $i = $j + 1;
                            }
                        } else {
                            $main_code .= $text;
                        }

                    }
                        break;

                    // Собираем основной код программы
                    default: $main_code .= $text; break;

It is generally recommended to place each PHP statement on a line by itself.

The default body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

                }
            }
        }

        //trace(' - Вышли из функции:'.$path.'('.$namespace.')');
        //trace('');

        // Replace all class shortcut usage with full name
        if (sizeof($file_uses)) {
            $main_code = $this->removeUSEStatement($main_code, $file_uses);

The method removeUSEStatement() does not exist on samsonphp\compressor\Code. Did you maybe mean removeUSE()?

        }

        // Запишем в коллекцию кода полученный код
        $code[ $namespace ][ $path ] = $main_code;

        return $main_code;
    }
}