CodeStyle.php

Go to the documentation of this file.

<?php

namespace Elgg\Project;

class CodeStyle {

    const KEY_NEW_CONTENT = 'new_content';
    const KEY_REMAINING = 'remaining';
    const KEY_CORRECTIONS = 'corrections';

    protected $file_pattern = '~\.(?:php|js|css|xml|json|yml|txt|rst|md|gitignore|htaccess|mailmap|sh)$~';

    protected $substr_start;

    public function fixDirectory($root, $dry_run = false) {
        $return = array();

        $this->substr_start = strlen($this->normalizePath($root)) + 1;

        $files = $this->findFilesToAnalyze($root);

        foreach ($files as $file) {
            $report = $this->analyzeFile($file);
            $key = substr($file, $this->substr_start);

            if ($dry_run) {
                $errors = $report[self::KEY_REMAINING];
                array_splice($errors, count($errors), 0, $report[self::KEY_CORRECTIONS]);
                if ($errors) {
                    $return[$key] = $errors;
                }
            } else {
                if ($report[self::KEY_NEW_CONTENT] !== null) {
                    file_put_contents($file, $report[self::KEY_NEW_CONTENT]);
                }
                if ($report[self::KEY_REMAINING]) {
                    $return[$key][self::KEY_REMAINING] = $report[self::KEY_REMAINING];
                }
                if ($report[self::KEY_CORRECTIONS]) {
                    $return[$key][self::KEY_CORRECTIONS] = $report[self::KEY_CORRECTIONS];
                }
            }
        }

        return $return;
    }

    public function findFilesToAnalyze($root) {
        $files = array();
        $this->substr_start = strlen($this->normalizePath($root)) + 1;
        $this->findFiles(rtrim($root, '/\\'), $files);
        return $files;
    }

    public function analyzeFile($filepath, $content = null) {
        if (!is_string($content)) {
            $content = file_get_contents($filepath);
        }
        $old = $content;
        unset($content);

        $return = array(
            self::KEY_REMAINING => array(),
            self::KEY_CORRECTIONS => array(),
            self::KEY_NEW_CONTENT => null,
        );

        // remove WS after non-WS
        $new = preg_replace('~(\S)[ \t]+(\r?\n)~', '$1$2', $old, -1, $count);
        if ($count) {
            $return[self::KEY_CORRECTIONS][] = "line(s) with trailing whitespace ($count)";
        }

        // don't risk breaking code blocks
        if (!preg_match('~\.(?:rst|md)$~', $filepath)) {
            // remove WS from empty lines
            $new = preg_replace('~^[ \t]+$~m', '', $new, -1, $count);
            if ($count) {
                $return[self::KEY_CORRECTIONS][] = "empty line(s) with whitespace ($count)";
            }
        }

        if (pathinfo($filepath, PATHINFO_EXTENSION) === 'php') {
            // remove close PHP tag at file end
            $new = preg_replace('~\?>\s*$~', '', $new, -1, $count);
            if ($count) {
                $return[self::KEY_CORRECTIONS][] = 'unnecessary close PHP tag';
            }
        }

        if ($new !== $old) {
            $return[self::KEY_NEW_CONTENT] = $new;
        }

        return $return;
    }

    protected function findFiles($dir, &$files) {
        $d = dir($dir);

        while (false !== ($entry = $d->read())) {
            if ($entry === '.' || $entry === '..') {
                continue;
            }

            $full = $this->normalizePath("{$d->path}/$entry");
            $relative_path = substr($full, $this->substr_start);

            if (is_dir($full)) {
                if ($entry[0] === '.' || preg_match('~(?:/vendors?)$~', $full)) {
                    // special case
                    if ($entry !== '.scripts') {
                        continue;
                    }
                }

                if (in_array($relative_path, array('node_modules', 'docs/_build'))) {
                    continue;
                }

                $this->findFiles($full, $files);
            } else {
                // file

                if (basename($dir) === 'languages' && $entry !== 'en.php') {
                    continue;
                }

                if ($relative_path === 'install/config/htaccess.dist' || preg_match($this->file_pattern, $entry)) {
                    $files[] = $full;
                    continue;
                }
            }
        }
        $d->close();
    }

    protected function normalizePath($path) {
        return str_replace('\\', '/', rtrim($path, '/\\'));
    }
}