You can now specify the full path to a coding standard on the command line rather than having to use one of the installed standards

git-svn-id: http://svn.php.net/repository/pear/packages/PHP_CodeSniffer/trunk@248400 c90b9560-bf6c-de11-be94-00142212c4b1

Author: gsherwood

CodeSniffer.php

@@ -232,7 +232,13 @@ public function process($files, $standard, array $sniffs=array(), $local=false)
             throw new PHP_CodeSniffer_Exception('$standard must be a string');
         }
 
-        $this->standardDir = realpath(dirname(__FILE__).'/CodeSniffer/Standards/'.$standard);
+        if (is_dir($standard) === true) {
+            // This is a custom standard.
+            $this->standardDir = $standard;
+            $standard          = basename($standard);
+        } else {
+            $this->standardDir = realpath(dirname(__FILE__).'/CodeSniffer/Standards/'.$standard);
+        }
 
         // Reset the members.
         $this->listeners = array();
@@ -373,10 +379,18 @@ public static function getSniffFiles($dir, $standard=null)
 
             $included = $standardClass->getIncludedSniffs();
             foreach ($included as $sniff) {
-                $sniffDir = realpath(dirname(__FILE__)."/CodeSniffer/Standards/$sniff");
-
-                if ($sniffDir === false) {
-                    throw new PHP_CodeSniffer_Exception("Included sniff $sniff does not exist");
+                if (is_dir($sniff) === true) {
+                    // Trying to include from a custom standard.
+                    $sniffDir = $sniff;
+                    $sniff    = basename($sniff);
+                } else if (is_file($sniff) === true) {
+                    // Trying to include a custom sniff.
+                    $sniffDir = $sniff;
+                } else {
+                    $sniffDir = realpath(dirname(__FILE__)."/CodeSniffer/Standards/$sniff");
+                    if ($sniffDir === false) {
+                        throw new PHP_CodeSniffer_Exception("Included sniff $sniff does not exist");
+                    }
                 }
 
                 if (is_dir($sniffDir) === true) {
@@ -398,10 +412,18 @@ public static function getSniffFiles($dir, $standard=null)
 
             $excluded = $standardClass->getExcludedSniffs();
             foreach ($excluded as $sniff) {
-                $sniffDir = realpath(dirname(__FILE__)."/CodeSniffer/Standards/$sniff");
-
-                if ($sniffDir === false) {
-                    throw new PHP_CodeSniffer_Exception("Excluded sniff $sniff does not exist");
+                if (is_dir($sniff) === true) {
+                    // Trying to exclude from a custom standard.
+                    $sniffDir = $sniff;
+                    $sniff    = basename($sniff);
+                } else if (is_file($sniff) === true) {
+                    // Trying to exclude a custom sniff.
+                    $sniffDir = $sniff;
+                } else {
+                    $sniffDir = realpath(dirname(__FILE__)."/CodeSniffer/Standards/$sniff");
+                    if ($sniffDir === false) {
+                        throw new PHP_CodeSniffer_Exception("Excluded sniff $sniff does not exist");
+                    }
                 }
 
                 if (is_dir($sniffDir) === true) {
@@ -1410,7 +1432,14 @@ public static function isInstalledStandard($standard)
     {
         $standardDir  = dirname(__FILE__);
         $standardDir .= '/CodeSniffer/Standards/'.$standard;
-        return (is_file("$standardDir/{$standard}CodingStandard.php") === true);
+        if (is_file("$standardDir/{$standard}CodingStandard.php") === true) {
+            return true;
+        } else {
+            // This could be a custom standard, installed outside our
+            // standards directory.
+            $standardFile = rtrim($standard, ' /\\').DIRECTORY_SEPARATOR.basename($standard).'CodingStandard.php';
+            return (is_file($standardFile) === true);
+        }
 
     }//end isInstalledStandard()
 

package.xml

@@ -32,6 +32,10 @@ http://pear.php.net/dtd/package-2.0.xsd">
  </stability>
  <license uri="http://matrix.squiz.net/developer/tools/php_cs/licence">BSD License</license>
  <notes>
+  - You can now specify the full path to a coding standard on the command line (feature request #11886)
+    - This allows you to use standards that are stored outside of PHP_CodeSniffer's own Standard dir
+    - You can also specify full paths in the CodingStandard.php include and exclude methods
+    - Classes, dirs and files need to be names as if the standard was part of PHP_CodeSniffer
   - Modified the scope map to keep checking after 3 lines for some tokens (feature request #12561)
     -- Those tokens that must have an opener (like T_CLASS) now keep looking until EOF
     -- Other tokens (like T_FUNCTION) still stop after 3 lines for performance

scripts/phpcs

@@ -90,15 +90,6 @@ function PHP_CodeSniffer_printInstalledStandards()
 }//end PHP_CodeSniffer_printInstalledStandards()
 
 
-// First, we need to ensure there is at least one coding standard
-// installed, or they will never be able to run this script.
-$installedStandards = PHP_CodeSniffer::getInstalledStandards();
-if (count($installedStandards) === 0) {
-    echo 'ERROR: There are no coding standards installed.'.PHP_EOL;
-    exit(2);
-}
-
-
 // The default values for config settings.
 $files      = array();
 $standard   = null;
@@ -253,17 +244,13 @@ foreach ($files as $file) {
     }
 }
 
-if (count($installedStandards) > 1) {
+if ($standard === null) {
+    // They did not supply a standard to use.
+    // Try to get the default from the config system.
+    $standard = PHP_CodeSniffer::getConfigData('default_standard');
     if ($standard === null) {
-        // They did not supply a standard to use.
-        // Try to get the default from the config system.
-        $standard = PHP_CodeSniffer::getConfigData('default_standard');
-        if ($standard === null) {
-            $standard = 'PEAR';
-        }
+        $standard = 'PEAR';
     }
-} else {
-    $standard = array_pop($installedStandards);
 }
 
 // Check if the standard name is valid. If not, check that the case