Initial Commit

database/php/pear/PHP/CodeSniffer/Reports/Gitblame.php

@@ -0,0 +1,133 @@
+<?php
+/**
+ * Gitblame report for PHP_CodeSniffer.
+ *
+ * PHP version 5
+ *
+ * @category  PHP
+ * @package   PHP_CodeSniffer
+ * @author    Ben Selby <benmatselby@gmail.com>
+ * @copyright 2009 SQLI <www.sqli.com>
+ * @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
+ * @license   http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
+ * @link      http://pear.php.net/package/PHP_CodeSniffer
+ */
+
+/**
+ * Gitblame report for PHP_CodeSniffer.
+ *
+ * PHP version 5
+ *
+ * @category  PHP
+ * @package   PHP_CodeSniffer
+ * @author    Ben Selby <benmatselby@gmail.com>
+ * @copyright 2009 SQLI <www.sqli.com>
+ * @copyright 2006-2011 Squiz Pty Ltd (ABN 77 084 670 600)
+ * @license   http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
+ * @version   Release: 1.2.2
+ * @link      http://pear.php.net/package/PHP_CodeSniffer
+ */
+class PHP_CodeSniffer_Reports_Gitblame extends PHP_CodeSniffer_Reports_VersionControl
+{
+
+    /**
+     * The name of the report we want in the output
+     *
+     * @var string
+     */
+    protected $reportName = 'GIT';
+
+
+    /**
+     * Extract the author from a blame line.
+     *
+     * @param string $line Line to parse.
+     *
+     * @return mixed string or false if impossible to recover.
+     */
+    protected function getAuthor($line)
+    {
+        $blameParts = array();
+        $line       = preg_replace('|\s+|', ' ', $line);
+        preg_match(
+            '|\(.+[0-9]{4}-[0-9]{2}-[0-9]{2}\s+[0-9]+\)|',
+            $line,
+            $blameParts
+        );
+
+        if (isset($blameParts[0]) === false) {
+            return false;
+        }
+
+        $parts = explode(' ', $blameParts[0]);
+
+        if (count($parts) < 2) {
+            return false;
+        }
+
+        $parts = array_slice($parts, 0, (count($parts) - 2));
+
+        return preg_replace('|\(|', '', implode($parts, ' '));
+
+    }//end getAuthor()
+
+
+    /**
+     * Gets the blame output.
+     *
+     * @param string $filename File to blame.
+     *
+     * @return array
+     */
+    protected function getBlameContent($filename)
+    {
+        $cwd = getcwd();
+
+        if (PHP_CODESNIFFER_VERBOSITY > 0) {
+            echo 'Getting GIT blame info for '.basename($filename).'... ';
+        }
+
+        $fileParts = explode('/', $filename);
+        $found     = false;
+        $location  = '';
+        while (empty($fileParts) === false) {
+            array_pop($fileParts);
+            $location = implode($fileParts, '/');
+            if (is_dir($location.'/.git') === true) {
+                $found = true;
+                break;
+            }
+        }
+
+        if ($found === true) {
+            chdir($location);
+        } else {
+            echo 'ERROR: Could not locate .git directory '.PHP_EOL.PHP_EOL;
+            exit(2);
+        }
+
+        $command = 'git blame --date=short '.$filename;
+        $handle  = popen($command, 'r');
+        if ($handle === false) {
+            echo 'ERROR: Could not execute "'.$command.'"'.PHP_EOL.PHP_EOL;
+            exit(2);
+        }
+
+        $rawContent = stream_get_contents($handle);
+        fclose($handle);
+
+        if (PHP_CODESNIFFER_VERBOSITY > 0) {
+            echo 'DONE'.PHP_EOL;
+        }
+
+        $blames = explode("\n", $rawContent);
+        chdir($cwd);
+
+        return $blames;
+
+    }//end getBlameContent()
+
+
+}//end class
+
+?>