summaryrefslogtreecommitdiff
path: root/buildscripts/phing/classes/phing/tasks/ext/phpmd
diff options
context:
space:
mode:
Diffstat (limited to 'buildscripts/phing/classes/phing/tasks/ext/phpmd')
-rw-r--r--buildscripts/phing/classes/phing/tasks/ext/phpmd/PHPMDFormatterElement.php181
-rw-r--r--buildscripts/phing/classes/phing/tasks/ext/phpmd/PHPMDTask.php284
2 files changed, 465 insertions, 0 deletions
diff --git a/buildscripts/phing/classes/phing/tasks/ext/phpmd/PHPMDFormatterElement.php b/buildscripts/phing/classes/phing/tasks/ext/phpmd/PHPMDFormatterElement.php
new file mode 100644
index 00000000..c327e331
--- /dev/null
+++ b/buildscripts/phing/classes/phing/tasks/ext/phpmd/PHPMDFormatterElement.php
@@ -0,0 +1,181 @@
+<?php
+/**
+ * $Id: 69fc758899446b96312ac12f26b461969eb41b6e $
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the LGPL. For more information please see
+ * <http://phing.info>.
+ */
+
+require_once 'phing/system/io/PhingFile.php';
+
+/**
+ * A wrapper for the implementations of PHPMDResultFormatter.
+ *
+ * @package phing.tasks.ext.phpmd
+ * @author Benjamin Schultz <bschultz@proqrent.de>
+ * @version $Id: 69fc758899446b96312ac12f26b461969eb41b6e $
+ * @since 2.4.1
+ */
+class PHPMDFormatterElement
+{
+ /**
+ * @var PHPMDResultFormatter
+ */
+ protected $formatter = null;
+
+ /**
+ * The type of the formatter.
+ *
+ * @var string
+ */
+ protected $type = "";
+
+ /**
+ * Whether to use file (or write output to phing log).
+ *
+ * @var boolean
+ */
+ protected $useFile = true;
+
+ /**
+ * Output file for formatter.
+ *
+ * @var PhingFile
+ */
+ protected $outfile = null;
+
+ /**
+ * Sets the formatter type.
+ *
+ * @param string $type Type of the formatter
+ *
+ * @return void
+ */
+ public function setType($type)
+ {
+ $this->type = $type;
+
+ switch ($this->type) {
+ case 'xml':
+ include_once 'PHP/PMD/Renderer/XMLRenderer.php';
+ break;
+
+ case 'html':
+ include_once 'PHP/PMD/Renderer/HTMLRenderer.php';
+ break;
+
+ case 'text':
+ include_once 'PHP/PMD/Renderer/TextRenderer.php';
+ break;
+
+ default:
+ throw new BuildException("Formatter '" . $this->type . "' not implemented");
+ }
+ }
+
+ /**
+ * Get the formatter type
+ *
+ * @return string
+ */
+ public function getType()
+ {
+ return $this->type;
+ }
+
+ /**
+ * Set whether to write formatter results to file or not.
+ *
+ * @param boolean $useFile True or false.
+ *
+ * @return void
+ */
+ public function setUseFile($useFile)
+ {
+ $this->useFile = (boolean) $useFile;
+ }
+
+ /**
+ * Return whether to write formatter results to file or not.
+ *
+ * @return boolean
+ */
+ public function getUseFile()
+ {
+ return $this->useFile;
+ }
+
+ /**
+ * Sets the output file for the formatter results.
+ *
+ * @param PhingFile $outfile The output file
+ *
+ * @return void
+ */
+ public function setOutfile(PhingFile $outfile)
+ {
+ $this->outfile = $outfile;
+ }
+
+ /**
+ * Get the output file.
+ *
+ * @return PhingFile
+ */
+ public function getOutfile()
+ {
+ return $this->outfile;
+ }
+
+ /**
+ * Creates a report renderer instance based on the formatter type.
+ *
+ * @return PHP_PMD_AbstractRenderer
+ * @throws BuildException When the specified renderer does not exist.
+ */
+ public function getRenderer()
+ {
+ switch ($this->type) {
+ case 'xml':
+ $renderer = new PHP_PMD_Renderer_XMLRenderer();
+ break;
+
+ case 'html':
+ $renderer = new PHP_PMD_Renderer_HTMLRenderer();
+ break;
+
+ case 'text':
+ $renderer = new PHP_PMD_Renderer_TextRenderer();
+ break;
+
+ default:
+ throw new BuildException("PHP_MD renderer '" . $this->type . "' not implemented");
+ }
+
+ // Create a report stream
+ if ($this->getUseFile() === false || $this->getOutfile() === null) {
+ $stream = STDOUT;
+ } else {
+ $stream = fopen($this->getOutfile()->getAbsoluteFile(), 'wb');
+ }
+
+ require_once 'PHP/PMD/Writer/Stream.php';
+
+ $renderer->setWriter(new PHP_PMD_Writer_Stream($stream));
+
+ return $renderer;
+ }
+} \ No newline at end of file
diff --git a/buildscripts/phing/classes/phing/tasks/ext/phpmd/PHPMDTask.php b/buildscripts/phing/classes/phing/tasks/ext/phpmd/PHPMDTask.php
new file mode 100644
index 00000000..1c4d34bf
--- /dev/null
+++ b/buildscripts/phing/classes/phing/tasks/ext/phpmd/PHPMDTask.php
@@ -0,0 +1,284 @@
+<?php
+/**
+ * $Id: 35668c2c6fbf1ca87fab21c26fd55ef630458fc7 $
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the LGPL. For more information please see
+ * <http://phing.info>.
+ */
+
+require_once 'phing/Task.php';
+require_once 'phing/tasks/ext/phpmd/PHPMDFormatterElement.php';
+
+/**
+ * Runs PHP Mess Detector. Checking PHP files for several potential problems
+ * based on rulesets.
+ *
+ * @package phing.tasks.ext.phpmd
+ * @author Benjamin Schultz <bschultz@proqrent.de>
+ * @version $Id: 35668c2c6fbf1ca87fab21c26fd55ef630458fc7 $
+ * @since 2.4.1
+ */
+class PHPMDTask extends Task
+{
+ /**
+ * A php source code filename or directory
+ *
+ * @var PhingFile
+ */
+ protected $file = null;
+
+ /**
+ * All fileset objects assigned to this task
+ *
+ * @var array<FileSet>
+ */
+ protected $filesets = array();
+
+ /**
+ * The rule-set filenames or identifier.
+ *
+ * @var string
+ */
+ protected $rulesets = 'codesize,unusedcode';
+
+ /**
+ * The minimum priority for rules to load.
+ *
+ * @var integer
+ */
+ protected $minimumPriority = 0;
+
+ /**
+ * List of valid file extensions for analyzed files.
+ *
+ * @var array
+ */
+ protected $allowedFileExtensions = array('php');
+
+ /**
+ * List of exclude directory patterns.
+ *
+ * @var array
+ */
+ protected $ignorePatterns = array('.git', '.svn', 'CVS', '.bzr', '.hg');
+
+ /**
+ * The format for the report
+ *
+ * @var string
+ */
+ protected $format = 'text';
+
+ /**
+ * Formatter elements.
+ *
+ * @var array<PHPMDFormatterElement>
+ */
+ protected $formatters = array();
+
+ /**
+ * Set the input source file or directory.
+ *
+ * @param PhingFile $file The input source file or directory.
+ *
+ * @return void
+ */
+ public function setFile(PhingFile $file)
+ {
+ $this->file = $file;
+ }
+
+ /**
+ * Nested creator, adds a set of files (nested fileset attribute).
+ *
+ * @return FileSet The created fileset object
+ */
+ public function createFileSet()
+ {
+ $num = array_push($this->filesets, new FileSet());
+ return $this->filesets[$num-1];
+ }
+
+ /**
+ * Sets the minimum rule priority.
+ *
+ * @param integer $minimumPriority Minimum rule priority.
+ *
+ * @return void
+ */
+ public function setMinimumPriority($minimumPriority)
+ {
+ $this->minimumPriority = $minimumPriority;
+ }
+
+ /**
+ * Sets the rule-sets.
+ *
+ * @param string $ruleSetFileNames Comma-separated string of rule-set filenames
+ * or identifier.
+ *
+ * @return void
+ */
+ public function setRulesets($ruleSetFileNames)
+ {
+ $this->rulesets = $ruleSetFileNames;
+ }
+
+ /**
+ * Sets a list of filename extensions for valid php source code files.
+ *
+ * @param string $fileExtensions List of valid file extensions without leading dot.
+ *
+ * @return void
+ */
+ public function setAllowedFileExtensions($fileExtensions)
+ {
+ $this->allowedFileExtensions = array();
+
+ $token = ' ,;';
+ $ext = strtok($fileExtensions, $token);
+
+ while ($ext !== false) {
+ $this->allowedFileExtensions[] = $ext;
+ $ext = strtok($token);
+ }
+ }
+
+ /**
+ * Sets a list of ignore patterns that is used to exclude directories from
+ * the source analysis.
+ *
+ * @param string $ignorePatterns List of ignore patterns.
+ *
+ * @return void
+ */
+ public function setIgnorePatterns($ignorePatterns)
+ {
+ $this->ignorePatterns = array();
+
+ $token = ' ,;';
+ $pattern = strtok($ignorePatterns, $token);
+
+ while ($pattern !== false) {
+ $this->ignorePatterns[] = $pattern;
+ $pattern = strtok($token);
+ }
+ }
+
+ /**
+ * Create object for nested formatter element.
+ *
+ * @return PHPMDFormatterElement
+ */
+ public function createFormatter()
+ {
+ $num = array_push($this->formatters, new PHPMDFormatterElement());
+ return $this->formatters[$num-1];
+ }
+
+ /**
+ * Executes PHPMD against PhingFile or a FileSet
+ *
+ * @throws BuildException - if the phpmd classes can't be loaded.
+ * @return void
+ */
+ public function main()
+ {
+ /**
+ * Find PHPMD
+ */
+ @include_once 'PHP/PMD.php';
+
+ if (! class_exists('PHP_PMD')) {
+ throw new BuildException(
+ 'PHPMDTask depends on PHPMD being installed and on include_path.',
+ $this->getLocation()
+ );
+ }
+
+ require_once 'PHP/PMD/AbstractRule.php';
+
+ if (!$this->minimumPriority) {
+ $this->minimumPriority = PHP_PMD_AbstractRule::LOWEST_PRIORITY;
+ }
+
+ if (!isset($this->file) and count($this->filesets) == 0) {
+ throw new BuildException("Missing either a nested fileset or attribute 'file' set");
+ }
+
+ if (count($this->formatters) == 0) {
+ // turn legacy format attribute into formatter
+ $fmt = new PHPMDFormatterElement();
+ $fmt->setType($this->format);
+ $fmt->setUseFile(false);
+ $this->formatters[] = $fmt;
+ }
+
+ $reportRenderers = array();
+
+ foreach ($this->formatters as $fe) {
+ if ($fe->getType() == '') {
+ throw new BuildException("Formatter missing required 'type' attribute.");
+ }
+ if ($fe->getUsefile() && $fe->getOutfile() === null) {
+ throw new BuildException("Formatter requires 'outfile' attribute when 'useFile' is true.");
+ }
+
+ $reportRenderers[] = $fe->getRenderer();
+ }
+
+ // Create a rule set factory
+ $ruleSetFactory = new PHP_PMD_RuleSetFactory();
+ $ruleSetFactory->setMinimumPriority($this->minimumPriority);
+
+ $phpmd = new PHP_PMD();
+
+ $phpmd->setFileExtensions($this->allowedFileExtensions);
+ $phpmd->setIgnorePattern($this->ignorePatterns);
+
+ $filesToParse = array();
+
+ if ($this->file instanceof PhingFile) {
+ $filesToParse[] = $this->file->getPath();
+ } else {
+ // append any files in filesets
+ foreach ($this->filesets as $fs) {
+ $files = $fs->getDirectoryScanner($this->project)->getIncludedFiles();
+ foreach ($files as $filename) {
+ $f = new PhingFile($fs->getDir($this->project), $filename);
+ $filesToParse[] = $f->getAbsolutePath();
+ }
+ }
+ }
+
+ if (count($filesToParse) > 0) {
+ $inputPath = implode(',', $filesToParse);
+
+ $this->log('Processing files...');
+
+ $phpmd->processFiles(
+ $inputPath,
+ $this->rulesets,
+ $reportRenderers,
+ $ruleSetFactory
+ );
+
+ $this->log('Finished processing files');
+ } else {
+ $this->log('No files to process');
+ }
+ }
+} \ No newline at end of file
generated by cgit v1.2.3 (git 2.39.1) at 2024-07-08 14:14:38 +0000