coder_review_sniffer.inc in Coder 7.2

This include file implements coder_review functionality for PHP_CodeSniffer.

File

coder_review/includes/coder_review_sniffer.inc

<?php

/**
 * @file
 * This include file implements coder_review functionality for PHP_CodeSniffer.
 */

/**
 * Implements hook_reviews().
 *
 * @throws \Exception
 *
 * @todo Should we add a use \Exception intruction at top of this file?
 */
function coder_review_sniffer_reviews() {
  $rules[] = array(
    '#type' => 'callback',
    '#value' => '_coder_review_sniffer_callback',
    '#source' => 'all',
  );

  // Load the primary PHP CodeSniffer class.
  try {
    @(include_once 'PHP/CodeSniffer.php');
  } catch (Exception $e) {
    $review['#description'] = ' You must install PHP Code_Sniffer.';
  }
  $review = array(
    '#title' => 'Drupal CodeSniffer',
    '#link' => 'http://pear.php.net/package/PHP_CodeSniffer',
    '#rules' => $rules,
    '#version' => 2,
    '#image' => 'images/sniffer.png',
    '#description' => 'Optional; Checks for PHP Coder_Sniffer rules.',
  );
  return array(
    'sniffer' => $review,
  );
}

/**
 * Rule callback: Runs the PHP_CodeSniffer rules.
 *
 * @see do_coder_review_callback()
 */
function _coder_review_sniffer_callback(array &$coder_args, array $review, array $rule, array $lines, array &$results) {
  if (!class_exists('PHP_CodeSniffer')) {
    _message(_t('PHP/CodeSniffer.php not found'), 'error');
    return;
  }

  // Include the CodeSniffer class once.
  // Allocate the CodeSniffer object once.
  static $phpcs, $phpcs_dir, $phpcs_cli;
  if (!isset($phpcs)) {

    // Allocate the CodeSniffer object.
    // Save the CodeSniffer directory, and restore our default directory.
    $current_dir = getcwd();
    $phpcs = new PHP_CodeSniffer(0, 0, 'utf-8');
    $phpcs_dir = getcwd();
    chdir($current_dir);

    // Bypass the CodeSniffer client which will always look at the command line options.
    class CoderReviewCodeSnifferClient extends PHP_CodeSniffer_CLI {
      protected $values = array();
      public function __construct($allowed_extensions = array()) {
        $this->values = $this
          ->getDefaults();
        $this->values['extensions'] = implode(',', $allowed_extensions);
        $this->errorSeverity = PHPCS_DEFAULT_ERROR_SEV;
        $this->warningSeverity = PHPCS_DEFAULT_WARN_SEV;
      }
      public function getCommandLineValues() {
        return $this->values;
      }

    }
    $allowed_extensions = array_merge($coder_args['#php_extensions'], $coder_args['#include_extensions'], array(
      'module',
    ));
    $phpcs_cli = new CoderReviewCodeSnifferClient($allowed_extensions);
    $phpcs
      ->setCli($phpcs_cli);
    $sniffer_dir = __DIR__ . '/../../coder_sniffer/Drupal';
    $phpcs
      ->process(array(), $sniffer_dir, array());
    $phpcs
      ->populateTokenListeners();
  }

  // Process this file.
  // Restore the CodeSniffer directory during file processing.
  // Then restore it back to our directory.
  $filename = realpath($coder_args['#filename']);
  if (!$filename) {
    $tmpname = drupal_tempnam('temporary://', 'file');
    if (file_put_contents($tmpname, $coder_args['#raw_contents']) !== FALSE) {
      $filename = $tmpname;
    }
  }
  $current_dir = getcwd();
  chdir($phpcs_dir);
  $phpcs_file = $phpcs
    ->processFile($filename, $coder_args['#raw_contents']);
  chdir($current_dir);

  // Read the errors.
  $errors = $phpcs_file
    ->getErrors();
  $warnings = $phpcs_file
    ->getWarnings();
  if ($errors || $warnings) {
    _coder_review_sniffer_warnings($results, $rule, $lines, $coder_args['#ignores'], $errors);
    _coder_review_sniffer_warnings($results, $rule, $lines, $coder_args['#ignores'], $warnings);
  }
  if (isset($tmpname) && $filename == $tmpname) {
    unlink($tmpname);
  }
}

/**
 * Stores the Code Sniffer warnings as Coder warnings.
 *
 * @param array $results
 *   A Results array variable to save errors to, passed by reference.
 * @param array $rule
 *   A Rule array that triggered the error.
 * @param array $lines
 *   Pertinent source file lines according to rule's '#source' value.
 * @param array $ignores
 *   An array of warnings to ignore.
 * @param array $sniffer_warnings
 *   An array of warning from a sniffer review.
 */
function _coder_review_sniffer_warnings(array &$results, array $rule, array $lines, array $ignores, array $sniffer_warnings) {
  foreach ($sniffer_warnings as $lineno => $sniffer_warning) {
    foreach ($sniffer_warning as $warning_no => $warning) {
      $tmprule = $rule;
      $tmprule['#review_name'] = 'sniffer';
      $tmprule['#rule_name'] = str_replace('.', '_', strtolower(str_replace('Drupal.', '', $warning[0]['source'])));
      $tmprule['#warning'] = $warning[0]['message'];

      // @todo: set the severiy name.
      $severity_name = 'minor';

      // $warning[0]['severity'];
      _coder_review_error($results, $tmprule, $severity_name, $lineno, isset($lines[$lineno][0]) ? $lines[$lineno][0] : '', $ignores);
    }
  }
}

Functions

Name	Description
coder_review_sniffer_reviews	Implements hook_reviews().
_coder_review_sniffer_callback	Rule callback: Runs the PHP_CodeSniffer rules.
_coder_review_sniffer_warnings	Stores the Code Sniffer warnings as Coder warnings.