Refactored structure

src/PHPCI/Plugin/Phing.php

@@ -0,0 +1,264 @@
+<?php
+/**
+ * PHPCI - Continuous Integration for PHP
+ *
+ * @copyright    Copyright 2014, Block 8 Limited.
+ * @license      https://github.com/Block8/PHPCI/blob/master/LICENSE.md
+ * @link         https://www.phptesting.org/
+ */
+
+namespace PHPCI\Plugin;
+
+use PHPCI\Builder;
+use PHPCI\Helper\Lang;
+use PHPCI\Model\Build;
+
+/**
+ * Phing Plugin - Provides access to Phing functionality.
+ *
+ * @author       Pavel Pavlov <ppavlov@alera.ru>
+ * @package      PHPCI
+ * @subpackage   Plugins
+ */
+class Phing implements \PHPCI\Plugin
+{
+
+    private $directory;
+    private $buildFile = 'build.xml';
+    private $targets = array('build');
+    private $properties = array();
+    private $propertyFile;
+
+    protected $phpci;
+    protected $build;
+
+    /**
+     * Set up the plugin, configure options, etc.
+     * @param Builder $phpci
+     * @param Build $build
+     * @param array $options
+     */
+    public function __construct(Builder $phpci, Build $build, array $options = array())
+    {
+        $this->setPhpci($phpci);
+        $this->build = $build;
+
+        /*
+         * Set working directory
+         */
+        if (isset($options['directory'])) {
+            $directory = $phpci->buildPath . DIRECTORY_SEPARATOR . $options['directory'];
+        } else {
+            $directory = $phpci->buildPath;
+        }
+
+        $this->setDirectory($directory);
+
+        /*
+         * Sen name of a non default build file
+         */
+        if (isset($options['build_file'])) {
+            $this->setBuildFile($options['build_file']);
+        }
+
+        if (isset($options['targets'])) {
+            $this->setTargets($options['targets']);
+        }
+
+        if (isset($options['properties'])) {
+            $this->setProperties($options['properties']);
+        }
+
+        if (isset($options['property_file'])) {
+            $this->setPropertyFile($options['property_file']);
+        }
+    }
+
+    /**
+     * Executes Phing and runs a specified targets
+     */
+    public function execute()
+    {
+        $phingExecutable = $this->phpci->findBinary('phing');
+
+        $cmd[] = $phingExecutable . ' -f ' . $this->getBuildFilePath();
+
+        if ($this->getPropertyFile()) {
+            $cmd[] = '-propertyfile ' . $this->getPropertyFile();
+        }
+
+        $cmd[] = $this->propertiesToString();
+
+        $cmd[] = '-logger phing.listener.DefaultLogger';
+        $cmd[] = $this->targetsToString();
+        $cmd[] = '2>&1';
+
+        return $this->phpci->executeCommand(implode(' ', $cmd), $this->directory, $this->targets);
+    }
+
+    /**
+     * @return \PHPCI\Builder
+     */
+    public function getPhpci()
+    {
+        return $this->phpci;
+    }
+
+    /**
+     * @param \PHPCI\Builder $phpci
+     *
+     * @return $this
+     */
+    public function setPhpci($phpci)
+    {
+        $this->phpci = $phpci;
+    }
+
+    /**
+     * @return string
+     */
+    public function getDirectory()
+    {
+        return $this->directory;
+    }
+
+    /**
+     * @param string $directory
+     *
+     * @return $this
+     */
+    public function setDirectory($directory)
+    {
+        $this->directory = $directory;
+    }
+
+    /**
+     * @return string
+     */
+    public function getTargets()
+    {
+        return $this->targets;
+    }
+
+    /**
+     * Converts an array of targets into a string.
+     * @return string
+     */
+    private function targetsToString()
+    {
+        return implode(' ', $this->targets);
+    }
+
+    /**
+     * @param array|string $targets
+     *
+     * @return $this
+     */
+    public function setTargets($targets)
+    {
+        if (is_string($targets)) {
+            $targets = array($targets);
+        }
+
+        $this->targets = $targets;
+    }
+
+    /**
+     * @return string
+     */
+    public function getBuildFile()
+    {
+        return $this->buildFile;
+    }
+
+    /**
+     * @param mixed $buildFile
+     *
+     * @return $this
+     * @throws \Exception
+     */
+    public function setBuildFile($buildFile)
+    {
+        if (!file_exists($this->getDirectory() . $buildFile)) {
+            throw new \Exception(Lang::get('build_file_missing'));
+        }
+
+        $this->buildFile = $buildFile;
+    }
+
+    /**
+     * Get phing build file path.
+     * @return string
+     */
+    public function getBuildFilePath()
+    {
+        return $this->getDirectory() . $this->buildFile;
+    }
+
+    /**
+     * @return mixed
+     */
+    public function getProperties()
+    {
+        return $this->properties;
+    }
+
+    /**
+     * @return string
+     */
+    public function propertiesToString()
+    {
+        /**
+         * fix the problem when execute phing out of the build dir
+         * @ticket 748
+         */
+        if (!isset($this->properties['project.basedir'])) {
+            $this->properties['project.basedir'] = $this->getDirectory();
+        }
+
+        $propertiesString = array();
+
+        foreach ($this->properties as $name => $value) {
+            $propertiesString[] = '-D' . $name . '="' . $value . '"';
+        }
+
+        return implode(' ', $propertiesString);
+    }
+
+    /**
+     * @param array|string $properties
+     *
+     * @return $this
+     */
+    public function setProperties($properties)
+    {
+        if (is_string($properties)) {
+            $properties = array($properties);
+        }
+
+        $this->properties = $properties;
+    }
+
+    /**
+     * @return string
+     */
+    public function getPropertyFile()
+    {
+        return $this->propertyFile;
+    }
+
+    /**
+     * @param string $propertyFile
+     *
+     * @return $this
+     * @throws \Exception
+     */
+    public function setPropertyFile($propertyFile)
+    {
+        if (!file_exists($this->getDirectory() . DIRECTORY_SEPARATOR . $propertyFile)) {
+            throw new \Exception(Lang::get('property_file_missing'));
+        }
+
+        $this->propertyFile = $propertyFile;
+    }
+}