silverstripe / deploynaut

code/backends/PackageCache.php

Indentation +16 added lines, -16 removed lines

@@ -6,20 +6,20 @@
 interface PackageCache
 {
 
-    /**
-     * Generate or retrieve a package from the cache
-     *
-     * @param PackageGenerator $generator The generator to use to create cache entries.
-     * @param string $identifier A unique identifier for the generator; used to partition the cache
-     * @param string $sha The SHA of the commit to be deployed
-     * @param string $repositoryDir The directory where the repository resides
-     * @param DeploynautLogFile $log The log to write status output to, including package-generation commands
-     */
-    public function getPackageFilename(
-        PackageGenerator $generator,
-        $identifier,
-        $sha,
-        $repositoryDir,
-        DeploynautLogFile $log
-    );
+	/**
+	 * Generate or retrieve a package from the cache
+	 *
+	 * @param PackageGenerator $generator The generator to use to create cache entries.
+	 * @param string $identifier A unique identifier for the generator; used to partition the cache
+	 * @param string $sha The SHA of the commit to be deployed
+	 * @param string $repositoryDir The directory where the repository resides
+	 * @param DeploynautLogFile $log The log to write status output to, including package-generation commands
+	 */
+	public function getPackageFilename(
+		PackageGenerator $generator,
+		$identifier,
+		$sha,
+		$repositoryDir,
+		DeploynautLogFile $log
+	);
 }

Braces +1 added lines, -2 removed lines

@@ -3,8 +3,7 @@
 /**
  * Represents a system for caching packages generated by a PackageGenerator
  */
-interface PackageCache
-{
+interface PackageCache {
 
     /**
      * Generate or retrieve a package from the cache

code/backends/PackageGenerator.php

Indentation +51 added lines, -51 removed lines

@@ -9,61 +9,61 @@
 abstract class PackageGenerator
 {
 
-    protected $cache;
+	protected $cache;
 
-    /**
-     * Generate the package file, saving to the given location
-     *
-     * @param string $baseDir string The base directory of the project, checked out from git.
-     * @param $outputFilename string The filename to write to.
-     * @param string $sha
-     *
-     * @return boolean True on success
-     */
-    abstract public function generatePackage($sha, $baseDir, $outputFilename, DeploynautLogFile $log);
+	/**
+	 * Generate the package file, saving to the given location
+	 *
+	 * @param string $baseDir string The base directory of the project, checked out from git.
+	 * @param $outputFilename string The filename to write to.
+	 * @param string $sha
+	 *
+	 * @return boolean True on success
+	 */
+	abstract public function generatePackage($sha, $baseDir, $outputFilename, DeploynautLogFile $log);
 
-    /**
-     * Return a string that uniquely identifies this package generator.
-     *
-     * This will be used as part of cache keys; if meaningful changes to the operation of the generator are
-     * made, then the identifier should change. Note there is no need to include the classname in the
-     * identifier; callers to getIdentifier() should be responsible for disambiguating based on class.
-     */
-    abstract public function getIdentifier();
+	/**
+	 * Return a string that uniquely identifies this package generator.
+	 *
+	 * This will be used as part of cache keys; if meaningful changes to the operation of the generator are
+	 * made, then the identifier should change. Note there is no need to include the classname in the
+	 * identifier; callers to getIdentifier() should be responsible for disambiguating based on class.
+	 */
+	abstract public function getIdentifier();
 
-    public function getCache()
-    {
-        return $this->cache;
-    }
+	public function getCache()
+	{
+		return $this->cache;
+	}
 
-    public function setCache(PackageCache $cache)
-    {
-        $this->cache = $cache;
-    }
+	public function setCache(PackageCache $cache)
+	{
+		$this->cache = $cache;
+	}
 
-    /**
-     * Generate or retrieve a package from the cache
-     *
-     * @param string $identifier A unique identifier for the generator; used to partition the cache
-     * @param string $sha The SHA of the commit to be deployed
-     * @param string $repositoryDir The directory where the repository resides
-     * @param DeploynautLogFile $log The log to write status output to, including package-generation commands
-     *
-     * @return string
-     */
-    public function getPackageFilename($identifier, $sha, $repositoryDir, DeploynautLogFile $log)
-    {
-        // Fetch through the cache
-        if ($this->cache) {
-            $identifier .= '-' . get_class($this) . '-' . $this->getIdentifier();
-            return $this->cache->getPackageFilename($this, $identifier, $sha, $repositoryDir, $log);
+	/**
+	 * Generate or retrieve a package from the cache
+	 *
+	 * @param string $identifier A unique identifier for the generator; used to partition the cache
+	 * @param string $sha The SHA of the commit to be deployed
+	 * @param string $repositoryDir The directory where the repository resides
+	 * @param DeploynautLogFile $log The log to write status output to, including package-generation commands
+	 *
+	 * @return string
+	 */
+	public function getPackageFilename($identifier, $sha, $repositoryDir, DeploynautLogFile $log)
+	{
+		// Fetch through the cache
+		if ($this->cache) {
+			$identifier .= '-' . get_class($this) . '-' . $this->getIdentifier();
+			return $this->cache->getPackageFilename($this, $identifier, $sha, $repositoryDir, $log);
 
-        // Default, cacheless implementation
-        } else {
-            $filename = TEMP_FOLDER . '/' . $sha . '.tar.gz';
-            if ($this->generatePackage($sha, $repositoryDir, $filename, $log)) {
-                return $filename;
-            }
-        }
-    }
+		// Default, cacheless implementation
+		} else {
+			$filename = TEMP_FOLDER . '/' . $sha . '.tar.gz';
+			if ($this->generatePackage($sha, $repositoryDir, $filename, $log)) {
+				return $filename;
+			}
+		}
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -54,14 +54,14 @@
     public function getPackageFilename($identifier, $sha, $repositoryDir, DeploynautLogFile $log)
     {
         // Fetch through the cache
-        if ($this->cache) {
+        if($this->cache) {
             $identifier .= '-' . get_class($this) . '-' . $this->getIdentifier();
             return $this->cache->getPackageFilename($this, $identifier, $sha, $repositoryDir, $log);
 
         // Default, cacheless implementation
         } else {
             $filename = TEMP_FOLDER . '/' . $sha . '.tar.gz';
-            if ($this->generatePackage($sha, $repositoryDir, $filename, $log)) {
+            if($this->generatePackage($sha, $repositoryDir, $filename, $log)) {
                 return $filename;
             }
         }

Braces +4 added lines, -8 removed lines

@@ -6,8 +6,7 @@ 
  *
  * These package generators can be used by applicable deployment backends.
  */
-abstract class PackageGenerator
-{
+abstract class PackageGenerator {
 
     protected $cache;
 
@@ -31,13 +30,11 @@ 
      */
     abstract public function getIdentifier();
 
-    public function getCache()
-    {
+    public function getCache() {
         return $this->cache;
     }
 
-    public function setCache(PackageCache $cache)
-    {
+    public function setCache(PackageCache $cache) {
         $this->cache = $cache;
     }
 
@@ -51,8 +48,7 @@ 
      *
      * @return string
      */
-    public function getPackageFilename($identifier, $sha, $repositoryDir, DeploynautLogFile $log)
-    {
+    public function getPackageFilename($identifier, $sha, $repositoryDir, DeploynautLogFile $log) {
         // Fetch through the cache
         if ($this->cache) {
             $identifier .= '-' . get_class($this) . '-' . $this->getIdentifier();

code/backends/SimplePackageGenerator.php

Indentation +71 added lines, -71 removed lines

@@ -8,86 +8,86 @@
 class SimplePackageGenerator extends PackageGenerator
 {
 
-    protected $buildScript = "composer install --prefer-dist --no-dev";
+	protected $buildScript = "composer install --prefer-dist --no-dev";
 
-    public function getParamMetadata()
-    {
-        return array(
-            'BuildScript' => array('title' => 'Build script'),
-        );
-    }
+	public function getParamMetadata()
+	{
+		return array(
+			'BuildScript' => array('title' => 'Build script'),
+		);
+	}
 
-    public function getBuildScript()
-    {
-        return $this->buildScript;
-    }
+	public function getBuildScript()
+	{
+		return $this->buildScript;
+	}
 
-    public function setBuildScript($buildScript)
-    {
-        $this->buildScript = $buildScript;
-    }
+	public function setBuildScript($buildScript)
+	{
+		$this->buildScript = $buildScript;
+	}
 
-    public function getIdentifier()
-    {
-        // If the build script changes, don't re-use cached items
-        return substr(sha1($this->buildScript), 0, 8);
-    }
+	public function getIdentifier()
+	{
+		// If the build script changes, don't re-use cached items
+		return substr(sha1($this->buildScript), 0, 8);
+	}
 
-    /**
-     * Generate the package
-     */
-    public function generatePackage($sha, $baseDir, $outputFilename, DeploynautLogFile $log)
-    {
-        $tempPath = TEMP_FOLDER . "/" . str_replace(".tar.gz", "", basename($outputFilename));
-        if (!file_exists($tempPath)) {
-            mkdir($tempPath);
-        }
+	/**
+	 * Generate the package
+	 */
+	public function generatePackage($sha, $baseDir, $outputFilename, DeploynautLogFile $log)
+	{
+		$tempPath = TEMP_FOLDER . "/" . str_replace(".tar.gz", "", basename($outputFilename));
+		if (!file_exists($tempPath)) {
+			mkdir($tempPath);
+		}
 
-        $escapedTempPath = escapeshellarg($tempPath);
-        $escapedOutputFile = escapeshellarg($outputFilename);
-        $escapedTempDir = escapeshellarg(basename($tempPath));
+		$escapedTempPath = escapeshellarg($tempPath);
+		$escapedOutputFile = escapeshellarg($outputFilename);
+		$escapedTempDir = escapeshellarg(basename($tempPath));
 
-        // Execute these in sequence until there's a failure
-        $processes = array(
-            // Export the relevant SHA into a temp folder
-            new Process("git archive $sha | tar -x -C " . $escapedTempPath, $baseDir),
-            // Run build script
-            new Process($this->buildScript, $tempPath, null, null, 3600),
-            // Compress the result
-            new Process("tar -czf " . $escapedOutputFile . " " . $escapedTempDir, dirname($tempPath)),
-        );
+		// Execute these in sequence until there's a failure
+		$processes = array(
+			// Export the relevant SHA into a temp folder
+			new Process("git archive $sha | tar -x -C " . $escapedTempPath, $baseDir),
+			// Run build script
+			new Process($this->buildScript, $tempPath, null, null, 3600),
+			// Compress the result
+			new Process("tar -czf " . $escapedOutputFile . " " . $escapedTempDir, dirname($tempPath)),
+		);
 
-        // Call at the end, regardless of success or failure
-        $cleanup = array(
-            // Delete the temporary staging folder
-            new Process("rm -rf " . $escapedTempPath),
-        );
+		// Call at the end, regardless of success or failure
+		$cleanup = array(
+			// Delete the temporary staging folder
+			new Process("rm -rf " . $escapedTempPath),
+		);
 
-        try {
-            $this->executeProcesses($processes, $log);
-        } catch (Exception $e) {
-            // Execute cleanup on failure
-            $this->executeProcesses($cleanup, $log);
-            throw $e;
-        }
+		try {
+			$this->executeProcesses($processes, $log);
+		} catch (Exception $e) {
+			// Execute cleanup on failure
+			$this->executeProcesses($cleanup, $log);
+			throw $e;
+		}
 
-        // Execute cleanup on success
-        $this->executeProcesses($cleanup, $log);
-        return true;
-    }
+		// Execute cleanup on success
+		$this->executeProcesses($cleanup, $log);
+		return true;
+	}
 
-    /**
-     * Execute an array of processes, one after the other, throwing an exception on the first failure.
-     *
-     * @param array $processes An array of Symfony\Component\Process\Process objects
-     * @param DeploynautLogFile $log The log to send output to
-     */
-    protected function executeProcesses($processes, DeploynautLogFile $log)
-    {
-        foreach ($processes as $process) {
-            $process->mustRun(function ($type, $buffer) use ($log) {
-                $log->write($buffer);
-            });
-        }
-    }
+	/**
+	 * Execute an array of processes, one after the other, throwing an exception on the first failure.
+	 *
+	 * @param array $processes An array of Symfony\Component\Process\Process objects
+	 * @param DeploynautLogFile $log The log to send output to
+	 */
+	protected function executeProcesses($processes, DeploynautLogFile $log)
+	{
+		foreach ($processes as $process) {
+			$process->mustRun(function ($type, $buffer) use ($log) {
+				$log->write($buffer);
+			});
+		}
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -39,7 +39,7 @@ 
     public function generatePackage($sha, $baseDir, $outputFilename, DeploynautLogFile $log)
     {
         $tempPath = TEMP_FOLDER . "/" . str_replace(".tar.gz", "", basename($outputFilename));
-        if (!file_exists($tempPath)) {
+        if(!file_exists($tempPath)) {
             mkdir($tempPath);
         }
 
@@ -65,7 +65,7 @@ 
 
         try {
             $this->executeProcesses($processes, $log);
-        } catch (Exception $e) {
+        } catch(Exception $e) {
             // Execute cleanup on failure
             $this->executeProcesses($cleanup, $log);
             throw $e;
@@ -84,8 +84,8 @@ 
      */
     protected function executeProcesses($processes, DeploynautLogFile $log)
     {
-        foreach ($processes as $process) {
-            $process->mustRun(function ($type, $buffer) use ($log) {
+        foreach($processes as $process) {
+            $process->mustRun(function($type, $buffer) use ($log) {
                 $log->write($buffer);
             });
         }

Braces +7 added lines, -14 removed lines

@@ -5,30 +5,25 @@ 
 /**
  * Generates the package directly on the deploynaut server
  */
-class SimplePackageGenerator extends PackageGenerator
-{
+class SimplePackageGenerator extends PackageGenerator {
 
     protected $buildScript = "composer install --prefer-dist --no-dev";
 
-    public function getParamMetadata()
-    {
+    public function getParamMetadata() {
         return array(
             'BuildScript' => array('title' => 'Build script'),
         );
     }
 
-    public function getBuildScript()
-    {
+    public function getBuildScript() {
         return $this->buildScript;
     }
 
-    public function setBuildScript($buildScript)
-    {
+    public function setBuildScript($buildScript) {
         $this->buildScript = $buildScript;
     }
 
-    public function getIdentifier()
-    {
+    public function getIdentifier() {
         // If the build script changes, don't re-use cached items
         return substr(sha1($this->buildScript), 0, 8);
     }
@@ -36,8 +31,7 @@ 
     /**
      * Generate the package
      */
-    public function generatePackage($sha, $baseDir, $outputFilename, DeploynautLogFile $log)
-    {
+    public function generatePackage($sha, $baseDir, $outputFilename, DeploynautLogFile $log) {
         $tempPath = TEMP_FOLDER . "/" . str_replace(".tar.gz", "", basename($outputFilename));
         if (!file_exists($tempPath)) {
             mkdir($tempPath);
@@ -82,8 +76,7 @@ 
      * @param array $processes An array of Symfony\Component\Process\Process objects
      * @param DeploynautLogFile $log The log to send output to
      */
-    protected function executeProcesses($processes, DeploynautLogFile $log)
-    {
+    protected function executeProcesses($processes, DeploynautLogFile $log) {
         foreach ($processes as $process) {
             $process->mustRun(function ($type, $buffer) use ($log) {
                 $log->write($buffer);

code/backends/SizeRestrictedPackageCache.php

Indentation +103 added lines, -103 removed lines

@@ -6,117 +6,117 @@
 class SizeRestrictedPackageCache implements PackageCache
 {
 
-    protected $cacheSize;
-    protected $baseDir;
+	protected $cacheSize;
+	protected $baseDir;
 
-    /**
-     * Set the maximum number of items that will be stored in the package cache.
-     *
-     * If null, items will never be deleted. If set, cache entries will be touched whenever they are accessed,
-     * and the least-recently-access items will be deleted.
-     *
-     * @param int $cacheSize the number of package files to keep.
-     */
-    public function setCacheSize($cacheSize)
-    {
-        $this->cacheSize = $cacheSize;
-    }
+	/**
+	 * Set the maximum number of items that will be stored in the package cache.
+	 *
+	 * If null, items will never be deleted. If set, cache entries will be touched whenever they are accessed,
+	 * and the least-recently-access items will be deleted.
+	 *
+	 * @param int $cacheSize the number of package files to keep.
+	 */
+	public function setCacheSize($cacheSize)
+	{
+		$this->cacheSize = $cacheSize;
+	}
 
-    /**
-     * The base directory to store cached packages in.
-     * The files will be stored in a subdirectory named after the identifier.
-     * If base directory isn't set, the getPackageFilename() won't run.
-     *
-     * @param string $baseDir The base directory
-     */
-    public function setBaseDir($baseDir)
-    {
-        $this->baseDir = realpath($baseDir);
-    }
+	/**
+	 * The base directory to store cached packages in.
+	 * The files will be stored in a subdirectory named after the identifier.
+	 * If base directory isn't set, the getPackageFilename() won't run.
+	 *
+	 * @param string $baseDir The base directory
+	 */
+	public function setBaseDir($baseDir)
+	{
+		$this->baseDir = realpath($baseDir);
+	}
 
-    /**
-     * Return the filename of the generated package, retrieving from cache or generating as necessary
-     *
-     * @param PackageGenerator $generator The generator to use to create cache entries.
-     * @param string $identifier A unique identifier for the generator; used to partition the cache
-     * @param string $sha The SHA of the commit to be deployed
-     * @param string $repositoryDir The directory where the repository resides
-     * @param DeploynautLogFile $log The log to write status output to, including package-generation commands
-     *
-     * @return string
-     */
-    public function getPackageFilename(
-        PackageGenerator $generator,
-        $identifier, $sha,
-        $repositoryDir,
-        DeploynautLogFile $log
-    ) {
-        if (!$this->baseDir) {
-            throw new \LogicException("Can't use PackageCache without setting BaseDir");
-        }
+	/**
+	 * Return the filename of the generated package, retrieving from cache or generating as necessary
+	 *
+	 * @param PackageGenerator $generator The generator to use to create cache entries.
+	 * @param string $identifier A unique identifier for the generator; used to partition the cache
+	 * @param string $sha The SHA of the commit to be deployed
+	 * @param string $repositoryDir The directory where the repository resides
+	 * @param DeploynautLogFile $log The log to write status output to, including package-generation commands
+	 *
+	 * @return string
+	 */
+	public function getPackageFilename(
+		PackageGenerator $generator,
+		$identifier, $sha,
+		$repositoryDir,
+		DeploynautLogFile $log
+	) {
+		if (!$this->baseDir) {
+			throw new \LogicException("Can't use PackageCache without setting BaseDir");
+		}
 
-        $buildPath = $this->baseDir . '/' . $this->sanitiseDirName($identifier);
-        $filename = "$buildPath/$sha.tar.gz";
+		$buildPath = $this->baseDir . '/' . $this->sanitiseDirName($identifier);
+		$filename = "$buildPath/$sha.tar.gz";
 
-        if (!file_exists($this->baseDir)) {
-            if (!mkdir($this->baseDir)) {
-                throw new \LogicException("Can't create base dir {$this->baseDir}");
-            }
-        }
-        if (!file_exists($buildPath)) {
-            if (!mkdir($buildPath)) {
-                throw new \LogicException("Can't create build path $buildPath");
-            }
-        }
+		if (!file_exists($this->baseDir)) {
+			if (!mkdir($this->baseDir)) {
+				throw new \LogicException("Can't create base dir {$this->baseDir}");
+			}
+		}
+		if (!file_exists($buildPath)) {
+			if (!mkdir($buildPath)) {
+				throw new \LogicException("Can't create build path $buildPath");
+			}
+		}
 
-        if (file_exists($filename)) {
-            $log->write("Using previously generated package $filename");
-            // This will ensure that our cache garbage collection will remove least-recently-accessed,
-            // rather than oldest.
-            touch($filename);
-            return $filename;
-        } else {
-            if ($this->cacheSize) {
-                $this->reduceDirSizeTo($buildPath, $this->cacheSize - 1, $log);
-            }
+		if (file_exists($filename)) {
+			$log->write("Using previously generated package $filename");
+			// This will ensure that our cache garbage collection will remove least-recently-accessed,
+			// rather than oldest.
+			touch($filename);
+			return $filename;
+		} else {
+			if ($this->cacheSize) {
+				$this->reduceDirSizeTo($buildPath, $this->cacheSize - 1, $log);
+			}
 
-            if ($generator->generatePackage($sha, $repositoryDir, $filename, $log)) {
-                return $filename;
-            }
-        }
-    }
+			if ($generator->generatePackage($sha, $repositoryDir, $filename, $log)) {
+				return $filename;
+			}
+		}
+	}
 
-    /**
-     * Take the identifier an make it safe to use as a directory name.
-     *
-     * @param string $identifier The unsanitised directory name.
-     */
-    protected function sanitiseDirName($identifier)
-    {
-        $safe = preg_replace('/[^A-Za-z0-9_-]/', '', $identifier);
-        return $safe ? $safe : 'null';
-    }
+	/**
+	 * Take the identifier an make it safe to use as a directory name.
+	 *
+	 * @param string $identifier The unsanitised directory name.
+	 */
+	protected function sanitiseDirName($identifier)
+	{
+		$safe = preg_replace('/[^A-Za-z0-9_-]/', '', $identifier);
+		return $safe ? $safe : 'null';
+	}
 
-    /**
-     * Delete items in this directory until the number of items is <= $count.
-     * Delete the oldest files first.
-     *
-     * @param string $dir The directory to remove items from
-     * @param int $count The maximum number of .tar.gz files that can appear in that directory
-     * @param DeploynautLogFile $log The log to send removal status messages to
-     */
-    protected function reduceDirSizeTo($dir, $count, DeploynautLogFile $log)
-    {
-        $files = glob($dir . '/*.tar.gz');
-        if (sizeof($files) > $count) {
-            usort($files, function ($a, $b) {
-                return filemtime($a) > filemtime($b);
-            });
+	/**
+	 * Delete items in this directory until the number of items is <= $count.
+	 * Delete the oldest files first.
+	 *
+	 * @param string $dir The directory to remove items from
+	 * @param int $count The maximum number of .tar.gz files that can appear in that directory
+	 * @param DeploynautLogFile $log The log to send removal status messages to
+	 */
+	protected function reduceDirSizeTo($dir, $count, DeploynautLogFile $log)
+	{
+		$files = glob($dir . '/*.tar.gz');
+		if (sizeof($files) > $count) {
+			usort($files, function ($a, $b) {
+				return filemtime($a) > filemtime($b);
+			});
 
-            for ($i = 0; $i < sizeof($files) - $count; $i++) {
-                $log->write("Removing " . $files[$i] . " from package cache");
-                unlink($files[$i]);
-            }
-        }
-    }
+			for ($i = 0; $i < sizeof($files) - $count; $i++) {
+				$log->write("Removing " . $files[$i] . " from package cache");
+				unlink($files[$i]);
+			}
+		}
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -51,36 +51,36 @@ 
         $repositoryDir,
         DeploynautLogFile $log
     ) {
-        if (!$this->baseDir) {
+        if(!$this->baseDir) {
             throw new \LogicException("Can't use PackageCache without setting BaseDir");
         }
 
         $buildPath = $this->baseDir . '/' . $this->sanitiseDirName($identifier);
         $filename = "$buildPath/$sha.tar.gz";
 
-        if (!file_exists($this->baseDir)) {
-            if (!mkdir($this->baseDir)) {
+        if(!file_exists($this->baseDir)) {
+            if(!mkdir($this->baseDir)) {
                 throw new \LogicException("Can't create base dir {$this->baseDir}");
             }
         }
-        if (!file_exists($buildPath)) {
-            if (!mkdir($buildPath)) {
+        if(!file_exists($buildPath)) {
+            if(!mkdir($buildPath)) {
                 throw new \LogicException("Can't create build path $buildPath");
             }
         }
 
-        if (file_exists($filename)) {
+        if(file_exists($filename)) {
             $log->write("Using previously generated package $filename");
             // This will ensure that our cache garbage collection will remove least-recently-accessed,
             // rather than oldest.
             touch($filename);
             return $filename;
         } else {
-            if ($this->cacheSize) {
+            if($this->cacheSize) {
                 $this->reduceDirSizeTo($buildPath, $this->cacheSize - 1, $log);
             }
 
-            if ($generator->generatePackage($sha, $repositoryDir, $filename, $log)) {
+            if($generator->generatePackage($sha, $repositoryDir, $filename, $log)) {
                 return $filename;
             }
         }
@@ -108,12 +108,12 @@ 
     protected function reduceDirSizeTo($dir, $count, DeploynautLogFile $log)
     {
         $files = glob($dir . '/*.tar.gz');
-        if (sizeof($files) > $count) {
-            usort($files, function ($a, $b) {
+        if(sizeof($files) > $count) {
+            usort($files, function($a, $b) {
                 return filemtime($a) > filemtime($b);
             });
 
-            for ($i = 0; $i < sizeof($files) - $count; $i++) {
+            for($i = 0; $i < sizeof($files) - $count; $i++) {
                 $log->write("Removing " . $files[$i] . " from package cache");
                 unlink($files[$i]);
             }

Braces +5 added lines, -10 removed lines

@@ -3,8 +3,7 @@ 
 /**
  * Class for calling the package generator and caching the results.
  */
-class SizeRestrictedPackageCache implements PackageCache
-{
+class SizeRestrictedPackageCache implements PackageCache {
 
     protected $cacheSize;
     protected $baseDir;
@@ -17,8 +16,7 @@ 
      *
      * @param int $cacheSize the number of package files to keep.
      */
-    public function setCacheSize($cacheSize)
-    {
+    public function setCacheSize($cacheSize) {
         $this->cacheSize = $cacheSize;
     }
 
@@ -29,8 +27,7 @@ 
      *
      * @param string $baseDir The base directory
      */
-    public function setBaseDir($baseDir)
-    {
+    public function setBaseDir($baseDir) {
         $this->baseDir = realpath($baseDir);
     }
 
@@ -91,8 +88,7 @@ 
      *
      * @param string $identifier The unsanitised directory name.
      */
-    protected function sanitiseDirName($identifier)
-    {
+    protected function sanitiseDirName($identifier) {
         $safe = preg_replace('/[^A-Za-z0-9_-]/', '', $identifier);
         return $safe ? $safe : 'null';
     }
@@ -105,8 +101,7 @@ 
      * @param int $count The maximum number of .tar.gz files that can appear in that directory
      * @param DeploynautLogFile $log The log to send removal status messages to
      */
-    protected function reduceDirSizeTo($dir, $count, DeploynautLogFile $log)
-    {
+    protected function reduceDirSizeTo($dir, $count, DeploynautLogFile $log) {
         $files = glob($dir . '/*.tar.gz');
         if (sizeof($files) > $count) {
             usort($files, function ($a, $b) {

code/control/CheckPipelineStatus.php

Indentation +22 added lines, -22 removed lines

@@ -10,31 +10,31 @@
  */
 class CheckPipelineStatus extends Controller
 {
-    public function index()
-    {
-        // @TODO Check that we have been called via the daemon
-        if (php_sapi_name() != "cli") {
-            throw new Exception("CheckPipelineStatus must be run from the command-line.");
-        }
+	public function index()
+	{
+		// @TODO Check that we have been called via the daemon
+		if (php_sapi_name() != "cli") {
+			throw new Exception("CheckPipelineStatus must be run from the command-line.");
+		}
 
-        $this->run();
-    }
+		$this->run();
+	}
 
-    private function run()
-    {
-        // Note that a pipeline must be started prior to being picked up by this task
-        $runningPipelines = Pipeline::get()->filter('Status', array('Running', 'Rollback'));
+	private function run()
+	{
+		// Note that a pipeline must be started prior to being picked up by this task
+		$runningPipelines = Pipeline::get()->filter('Status', array('Running', 'Rollback'));
 
-        printf(
-            "%s Checking status of %d pipelines... ",
-            "[" . date("Y-m-d H:i:s") . "]",
-            $runningPipelines->count()
-        );
+		printf(
+			"%s Checking status of %d pipelines... ",
+			"[" . date("Y-m-d H:i:s") . "]",
+			$runningPipelines->count()
+		);
 
-        foreach ($runningPipelines as $pipeline) {
-            $pipeline->checkPipelineStatus();
-        }
+		foreach ($runningPipelines as $pipeline) {
+			$pipeline->checkPipelineStatus();
+		}
 
-        echo "done!" . PHP_EOL;
-    }
+		echo "done!" . PHP_EOL;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -13,7 +13,7 @@ 
     public function index()
     {
         // @TODO Check that we have been called via the daemon
-        if (php_sapi_name() != "cli") {
+        if(php_sapi_name() != "cli") {
             throw new Exception("CheckPipelineStatus must be run from the command-line.");
         }
 
@@ -31,7 +31,7 @@ 
             $runningPipelines->count()
         );
 
-        foreach ($runningPipelines as $pipeline) {
+        foreach($runningPipelines as $pipeline) {
             $pipeline->checkPipelineStatus();
         }
 

Braces +3 added lines, -6 removed lines

@@ -8,10 +8,8 @@ 
  * @package deploynaut
  * @subpackage control
  */
-class CheckPipelineStatus extends Controller
-{
-    public function index()
-    {
+class CheckPipelineStatus extends Controller {
+    public function index() {
         // @TODO Check that we have been called via the daemon
         if (php_sapi_name() != "cli") {
             throw new Exception("CheckPipelineStatus must be run from the command-line.");
@@ -20,8 +18,7 @@ 
         $this->run();
     }
 
-    private function run()
-    {
+    private function run() {
         // Note that a pipeline must be started prior to being picked up by this task
         $runningPipelines = Pipeline::get()->filter('Status', array('Running', 'Rollback'));
 

code/control/ConfirmationMessagingService.php

Indentation +10 added lines, -10 removed lines

@@ -7,14 +7,14 @@
 interface ConfirmationMessagingService
 {
 
-    /**
-     * Sends a message to the specified user
-     *
-     * @param PipelineData $source Source client step
-     * @param string $message Plain text message
-     * @param mixed $recipients Either a Member object, string, or array of strings or Member objects
-     * @param array $arguments Additional arguments that may be configured
-     * @return boolean True if success
-     */
-    public function sendMessage($source, $message, $recipients, $arguments = array());
+	/**
+	 * Sends a message to the specified user
+	 *
+	 * @param PipelineData $source Source client step
+	 * @param string $message Plain text message
+	 * @param mixed $recipients Either a Member object, string, or array of strings or Member objects
+	 * @param array $arguments Additional arguments that may be configured
+	 * @return boolean True if success
+	 */
+	public function sendMessage($source, $message, $recipients, $arguments = array());
 }

Braces +1 added lines, -2 removed lines

@@ -4,8 +4,7 @@
  * @package deploynaut
  * @subpackage control
  */
-interface ConfirmationMessagingService
-{
+interface ConfirmationMessagingService {
 
     /**
      * Sends a message to the specified user

code/control/DNAdmin.php

Indentation +20 added lines, -20 removed lines

@@ -3,27 +3,27 @@
 class DNAdmin extends ModelAdmin
 {
 
-    /**
-     * @var string
-     */
-    public static $menu_title = "Deploynaut Projects";
+	/**
+	 * @var string
+	 */
+	public static $menu_title = "Deploynaut Projects";
 
-    /**
-     * @var string
-     */
-    public static $url_segment = "naut";
+	/**
+	 * @var string
+	 */
+	public static $url_segment = "naut";
 
-    /**
-     * @var array
-     */
-    public static $managed_models = array(
-        'DNProject' => array('title' => 'Projects'),
-        'DNDataTransfer' => array('title' => 'Transfers'),
-        'DNDataArchive' => array('title' => 'Archives'),
-    );
+	/**
+	 * @var array
+	 */
+	public static $managed_models = array(
+		'DNProject' => array('title' => 'Projects'),
+		'DNDataTransfer' => array('title' => 'Transfers'),
+		'DNDataArchive' => array('title' => 'Archives'),
+	);
 
-    /**
-     * @var int
-     */
-    private static $menu_priority = 100;
+	/**
+	 * @var int
+	 */
+	private static $menu_priority = 100;
 }

Braces +1 added lines, -2 removed lines

@@ -1,7 +1,6 @@
 <?php
 
-class DNAdmin extends ModelAdmin
-{
+class DNAdmin extends ModelAdmin {
 
     /**
      * @var string

code/control/DeployForm.php

Indentation +292 added lines, -292 removed lines

@@ -9,49 +9,49 @@ 
 abstract class DeployForm_ValidatorBase extends Validator
 {
 
-    /**
-     * @param string $fieldName
-     * @param string $message
-     * @param string $messageType
-     */
-    public function validationError($fieldName, $message, $messageType = '')
-    {
-        // Just make any error use the form message
-        $this->form->sessionMessage($message, $messageType);
-        parent::validationError($fieldName, $message, $messageType);
-    }
+	/**
+	 * @param string $fieldName
+	 * @param string $message
+	 * @param string $messageType
+	 */
+	public function validationError($fieldName, $message, $messageType = '')
+	{
+		// Just make any error use the form message
+		$this->form->sessionMessage($message, $messageType);
+		parent::validationError($fieldName, $message, $messageType);
+	}
 
-    /**
-     * Validate a commit sha
-     *
-     * @param string $sha
-     * @param string $field
-     * @return boolean
-     */
-    protected function validateCommit($sha, $field)
-    {
-        // Check selected commit
-        if (empty($sha)) {
-            $this->validationError(
-                $field,
-                "No valid release selected",
-                "required"
-            );
-            return false;
-        }
+	/**
+	 * Validate a commit sha
+	 *
+	 * @param string $sha
+	 * @param string $field
+	 * @return boolean
+	 */
+	protected function validateCommit($sha, $field)
+	{
+		// Check selected commit
+		if (empty($sha)) {
+			$this->validationError(
+				$field,
+				"No valid release selected",
+				"required"
+			);
+			return false;
+		}
 
-        // Check validity of commit
-        if (!preg_match('/^[a-f0-9]{40}$/', $sha)) {
-            $this->validationError(
-                $field,
-                "Invalid release SHA: " . Convert::raw2xml($sha),
-                "error"
-            );
-            return false;
-        }
+		// Check validity of commit
+		if (!preg_match('/^[a-f0-9]{40}$/', $sha)) {
+			$this->validationError(
+				$field,
+				"Invalid release SHA: " . Convert::raw2xml($sha),
+				"error"
+			);
+			return false;
+		}
 
-        return true;
-    }
+		return true;
+	}
 }
 
 /**
@@ -63,27 +63,27 @@ 
 class DeployForm_CommitValidator extends DeployForm_ValidatorBase
 {
 
-    public function php($data)
-    {
-        // Check release method
-        if (empty($data['SelectRelease'])
-            || !in_array($data['SelectRelease'], array('Tag', 'Branch', 'Redeploy', 'SHA', 'FilteredCommits'))
-        ) {
-            $method = empty($data['SelectRelease']) ? '(blank)' : $data['SelectRelease'];
-            $this->validationError(
-                'SelectRelease',
-                "Bad release selection method: $method",
-                "error"
-            );
-            return false;
-        }
+	public function php($data)
+	{
+		// Check release method
+		if (empty($data['SelectRelease'])
+			|| !in_array($data['SelectRelease'], array('Tag', 'Branch', 'Redeploy', 'SHA', 'FilteredCommits'))
+		) {
+			$method = empty($data['SelectRelease']) ? '(blank)' : $data['SelectRelease'];
+			$this->validationError(
+				'SelectRelease',
+				"Bad release selection method: $method",
+				"error"
+			);
+			return false;
+		}
 
-        // Check sha
-        return $this->validateCommit(
-            $this->form->getSelectedBuild($data),
-            'SelectRelease'
-        );
-    }
+		// Check sha
+		return $this->validateCommit(
+			$this->form->getSelectedBuild($data),
+			'SelectRelease'
+		);
+	}
 }
 
 /**
@@ -95,13 +95,13 @@ 
 class DeployForm_PipelineValidator extends DeployForm_ValidatorBase
 {
 
-    public function php($data)
-    {
-        return $this->validateCommit(
-            $this->form->getSelectedBuild($data),
-            'FilteredCommits'
-        );
-    }
+	public function php($data)
+	{
+		return $this->validateCommit(
+			$this->form->getSelectedBuild($data),
+			'FilteredCommits'
+		);
+	}
 }
 
 /**
@@ -113,240 +113,240 @@ 
 class DeployForm extends Form
 {
 
-    /**
-     * @param DNRoot $controller
-     * @param string $name
-     * @param DNEnvironment $environment
-     * @param DNProject $project
-     */
-    public function __construct($controller, $name, DNEnvironment $environment, DNProject $project)
-    {
-        if ($environment->HasPipelineSupport()) {
-            list($field, $validator, $actions) = $this->setupPipeline($environment, $project);
-        } else {
-            list($field, $validator, $actions) = $this->setupSimpleDeploy($project);
-        }
-        parent::__construct($controller, $name, new FieldList($field), $actions, $validator);
-    }
+	/**
+	 * @param DNRoot $controller
+	 * @param string $name
+	 * @param DNEnvironment $environment
+	 * @param DNProject $project
+	 */
+	public function __construct($controller, $name, DNEnvironment $environment, DNProject $project)
+	{
+		if ($environment->HasPipelineSupport()) {
+			list($field, $validator, $actions) = $this->setupPipeline($environment, $project);
+		} else {
+			list($field, $validator, $actions) = $this->setupSimpleDeploy($project);
+		}
+		parent::__construct($controller, $name, new FieldList($field), $actions, $validator);
+	}
 
-    /**
-     * @param DNProject $project
-     *
-     * @return array
-     */
-    protected function setupSimpleDeploy(DNProject $project)
-    {
-        // without a pipeline simply allow any commit to be selected
-        $field = $this->buildCommitSelector($project);
-        $validator = new DeployForm_CommitValidator();
-        $actions = new FieldList(
-            new FormAction('showDeploySummary', 'Plan deployment', 'Show deployment plan'),
-            new FormAction('doDeploy', 'Do deploy', 'Do deploy')
-        );
-        return array($field, $validator, $actions);
-    }
+	/**
+	 * @param DNProject $project
+	 *
+	 * @return array
+	 */
+	protected function setupSimpleDeploy(DNProject $project)
+	{
+		// without a pipeline simply allow any commit to be selected
+		$field = $this->buildCommitSelector($project);
+		$validator = new DeployForm_CommitValidator();
+		$actions = new FieldList(
+			new FormAction('showDeploySummary', 'Plan deployment', 'Show deployment plan'),
+			new FormAction('doDeploy', 'Do deploy', 'Do deploy')
+		);
+		return array($field, $validator, $actions);
+	}
 
-    /**
-     * @param DNEnvironment $environment
-     * @param DNProject $project
-     *
-     * @return array
-     * @throws Exception
-     */
-    protected function setupPipeline(DNEnvironment $environment, DNProject $project)
-    {
-        // Determine if commits are filtered
-        $canBypass = Permission::check(DNRoot::DEPLOYNAUT_BYPASS_PIPELINE);
-        $canDryrun = $environment->DryRunEnabled && Permission::check(DNRoot::DEPLOYNAUT_DRYRUN_PIPELINE);
-        $commits = $environment->getDependentFilteredCommits();
-        if (empty($commits)) {
-            // There are no filtered commits, so show all commits
-            $field = $this->buildCommitSelector($project);
-            $validator = new DeployForm_CommitValidator();
-        } elseif ($canBypass) {
-            // Build hybrid selector that allows users to follow pipeline or use any commit
-            $field = $this->buildCommitSelector($project, $commits);
-            $validator = new DeployForm_CommitValidator();
-        } else {
-            // Restrict user to only select pipeline filtered commits
-            $field = $this->buildPipelineField($commits);
-            $validator = new DeployForm_PipelineValidator();
-        }
+	/**
+	 * @param DNEnvironment $environment
+	 * @param DNProject $project
+	 *
+	 * @return array
+	 * @throws Exception
+	 */
+	protected function setupPipeline(DNEnvironment $environment, DNProject $project)
+	{
+		// Determine if commits are filtered
+		$canBypass = Permission::check(DNRoot::DEPLOYNAUT_BYPASS_PIPELINE);
+		$canDryrun = $environment->DryRunEnabled && Permission::check(DNRoot::DEPLOYNAUT_DRYRUN_PIPELINE);
+		$commits = $environment->getDependentFilteredCommits();
+		if (empty($commits)) {
+			// There are no filtered commits, so show all commits
+			$field = $this->buildCommitSelector($project);
+			$validator = new DeployForm_CommitValidator();
+		} elseif ($canBypass) {
+			// Build hybrid selector that allows users to follow pipeline or use any commit
+			$field = $this->buildCommitSelector($project, $commits);
+			$validator = new DeployForm_CommitValidator();
+		} else {
+			// Restrict user to only select pipeline filtered commits
+			$field = $this->buildPipelineField($commits);
+			$validator = new DeployForm_PipelineValidator();
+		}
 
-        // Generate actions allowed for this user
-        $actions = new FieldList(
-            FormAction::create('startPipeline', "Begin the release process on " . $environment->Name)
-                ->addExtraClass('btn btn-primary')
-                ->setAttribute('onclick', "return confirm('This will begin a release pipeline. Continue?');")
-        );
-        if ($canDryrun) {
-            $actions->push(
-                FormAction::create('doDryRun', "Dry-run release process")
-                    ->addExtraClass('btn btn-info')
-                    ->setAttribute(
-                        'onclick',
-                        "return confirm('This will begin a release pipeline, but with the following exclusions:\\n" .
-                        " - No messages will be sent\\n" .
-                        " - No capistrano actions will be invoked\\n" .
-                        " - No deployments or snapshots will be created.');"
-                    )
-            );
-        }
-        if ($canBypass) {
-            $actions->push(
-                FormAction::create('showDeploySummary', "Direct deployment (bypass pipeline)")
-                    ->addExtraClass('btn btn-warning')
-                    ->setAttribute(
-                        'onclick',
-                        "return confirm('This will start a direct deployment, bypassing the pipeline " .
-                        "process in place.\\n\\nAre you sure this is necessary?');"
-                    )
-            );
-            return array($field, $validator, $actions);
-        }
-        return array($field, $validator, $actions);
-    }
+		// Generate actions allowed for this user
+		$actions = new FieldList(
+			FormAction::create('startPipeline', "Begin the release process on " . $environment->Name)
+				->addExtraClass('btn btn-primary')
+				->setAttribute('onclick', "return confirm('This will begin a release pipeline. Continue?');")
+		);
+		if ($canDryrun) {
+			$actions->push(
+				FormAction::create('doDryRun', "Dry-run release process")
+					->addExtraClass('btn btn-info')
+					->setAttribute(
+						'onclick',
+						"return confirm('This will begin a release pipeline, but with the following exclusions:\\n" .
+						" - No messages will be sent\\n" .
+						" - No capistrano actions will be invoked\\n" .
+						" - No deployments or snapshots will be created.');"
+					)
+			);
+		}
+		if ($canBypass) {
+			$actions->push(
+				FormAction::create('showDeploySummary', "Direct deployment (bypass pipeline)")
+					->addExtraClass('btn btn-warning')
+					->setAttribute(
+						'onclick',
+						"return confirm('This will start a direct deployment, bypassing the pipeline " .
+						"process in place.\\n\\nAre you sure this is necessary?');"
+					)
+			);
+			return array($field, $validator, $actions);
+		}
+		return array($field, $validator, $actions);
+	}
 
-    /**
-     * Construct fields to select any commit
-     *
-     * @param DNProject $project
-     * @param DataList|null $pipelineCommits Optional list of pipeline-filtered commits to include
-     * @return FormField
-     */
-    protected function buildCommitSelector($project, $pipelineCommits = null)
-    {
-        // Branches
-        $branches = array();
-        foreach ($project->DNBranchList() as $branch) {
-            $sha = $branch->SHA();
-            $name = $branch->Name();
-            $branchValue = sprintf("%s (%s, %s old)",
-                $name,
-                substr($sha, 0, 8),
-                $branch->LastUpdated()->TimeDiff()
-            );
-            $branches[$sha . '-' . $name] = $branchValue;
-        }
+	/**
+	 * Construct fields to select any commit
+	 *
+	 * @param DNProject $project
+	 * @param DataList|null $pipelineCommits Optional list of pipeline-filtered commits to include
+	 * @return FormField
+	 */
+	protected function buildCommitSelector($project, $pipelineCommits = null)
+	{
+		// Branches
+		$branches = array();
+		foreach ($project->DNBranchList() as $branch) {
+			$sha = $branch->SHA();
+			$name = $branch->Name();
+			$branchValue = sprintf("%s (%s, %s old)",
+				$name,
+				substr($sha, 0, 8),
+				$branch->LastUpdated()->TimeDiff()
+			);
+			$branches[$sha . '-' . $name] = $branchValue;
+		}
 
-        // Tags
-        $tags = array();
-        foreach ($project->DNTagList()->setLimit(null) as $tag) {
-            $sha = $tag->SHA();
-            $name = $tag->Name();
-            $tagValue = sprintf("%s (%s, %s old)",
-                $name,
-                substr($sha, 0, 8),
-                $branch->LastUpdated()->TimeDiff()
-            );
-            $tags[$sha . '-' . $tag] = $tagValue;
-        }
-        $tags = array_reverse($tags);
+		// Tags
+		$tags = array();
+		foreach ($project->DNTagList()->setLimit(null) as $tag) {
+			$sha = $tag->SHA();
+			$name = $tag->Name();
+			$tagValue = sprintf("%s (%s, %s old)",
+				$name,
+				substr($sha, 0, 8),
+				$branch->LastUpdated()->TimeDiff()
+			);
+			$tags[$sha . '-' . $tag] = $tagValue;
+		}
+		$tags = array_reverse($tags);
 
-        // Past deployments
-        $redeploy = array();
-        foreach ($project->DNEnvironmentList() as $dnEnvironment) {
-            $envName = $dnEnvironment->Name;
-            foreach ($dnEnvironment->DeployHistory() as $deploy) {
-                $sha = $deploy->SHA;
-                if (!isset($redeploy[$envName])) {
-                    $redeploy[$envName] = array();
-                }
-                if (!isset($redeploy[$envName][$sha])) {
-                    $pastValue = sprintf("%s (deployed %s)",
-                        substr($sha, 0, 8),
-                        $deploy->obj('LastEdited')->Ago()
-                    );
-                    $redeploy[$envName][$sha] = $pastValue;
-                }
-            }
-        }
+		// Past deployments
+		$redeploy = array();
+		foreach ($project->DNEnvironmentList() as $dnEnvironment) {
+			$envName = $dnEnvironment->Name;
+			foreach ($dnEnvironment->DeployHistory() as $deploy) {
+				$sha = $deploy->SHA;
+				if (!isset($redeploy[$envName])) {
+					$redeploy[$envName] = array();
+				}
+				if (!isset($redeploy[$envName][$sha])) {
+					$pastValue = sprintf("%s (deployed %s)",
+						substr($sha, 0, 8),
+						$deploy->obj('LastEdited')->Ago()
+					);
+					$redeploy[$envName][$sha] = $pastValue;
+				}
+			}
+		}
 
-        // Merge fields
-        $releaseMethods = array();
-        if ($pipelineCommits) {
-            $releaseMethods[] = new SelectionGroup_Item(
-                'FilteredCommits',
-                $this->buildPipelineField($pipelineCommits),
-                'Deploy a commit prepared for this pipeline'
-            );
-        }
-        if (!empty($branches)) {
-            $releaseMethods[] = new SelectionGroup_Item(
-                'Branch',
-                new DropdownField('Branch', 'Select a branch', $branches),
-                'Deploy the latest version of a branch'
-            );
-        }
-        if ($tags) {
-            $releaseMethods[] = new SelectionGroup_Item(
-                'Tag',
-                new DropdownField('Tag', 'Select a tag', $tags),
-                'Deploy a tagged release'
-            );
-        }
-        if ($redeploy) {
-            $releaseMethods[] = new SelectionGroup_Item(
-                'Redeploy',
-                new GroupedDropdownField('Redeploy', 'Redeploy', $redeploy),
-                'Redeploy a release that was previously deployed (to any environment)'
-            );
-        }
+		// Merge fields
+		$releaseMethods = array();
+		if ($pipelineCommits) {
+			$releaseMethods[] = new SelectionGroup_Item(
+				'FilteredCommits',
+				$this->buildPipelineField($pipelineCommits),
+				'Deploy a commit prepared for this pipeline'
+			);
+		}
+		if (!empty($branches)) {
+			$releaseMethods[] = new SelectionGroup_Item(
+				'Branch',
+				new DropdownField('Branch', 'Select a branch', $branches),
+				'Deploy the latest version of a branch'
+			);
+		}
+		if ($tags) {
+			$releaseMethods[] = new SelectionGroup_Item(
+				'Tag',
+				new DropdownField('Tag', 'Select a tag', $tags),
+				'Deploy a tagged release'
+			);
+		}
+		if ($redeploy) {
+			$releaseMethods[] = new SelectionGroup_Item(
+				'Redeploy',
+				new GroupedDropdownField('Redeploy', 'Redeploy', $redeploy),
+				'Redeploy a release that was previously deployed (to any environment)'
+			);
+		}
 
-        $releaseMethods[] = new SelectionGroup_Item(
-            'SHA',
-            new Textfield('SHA', 'Please specify the full SHA'),
-            'Deploy a specific SHA'
-        );
+		$releaseMethods[] = new SelectionGroup_Item(
+			'SHA',
+			new Textfield('SHA', 'Please specify the full SHA'),
+			'Deploy a specific SHA'
+		);
 
-        $field = new TabbedSelectionGroup('SelectRelease', $releaseMethods);
-        $field->setValue(reset($releaseMethods)->getValue());
-        return $field;
-    }
+		$field = new TabbedSelectionGroup('SelectRelease', $releaseMethods);
+		$field->setValue(reset($releaseMethods)->getValue());
+		return $field;
+	}
 
-    /**
-     * Generate fields necessary to select from a filtered commit list
-     *
-     * @param DataList $commits List of commits
-     * @return FormField
-     */
-    protected function buildPipelineField($commits)
-    {
-        // Get filtered commits
-        $filteredCommits = array();
-        foreach ($commits as $commit) {
-            $title = sprintf(
-                "%s (%s, %s old)",
-                $commit->Message,
-                substr($commit->SHA, 0, 8),
-                $commit->dbObject('Created')->TimeDiff()
-            );
-            $filteredCommits[$commit->SHA] = $title;
-        }
-        if ($filteredCommits) {
-            return new DropdownField('FilteredCommits', '', $filteredCommits);
-        } else {
-            return DropdownField::create('FilteredCommits)', '')
-                ->setEmptyString('No deployments available')
-                ->performDisabledTransformation();
-        }
-    }
+	/**
+	 * Generate fields necessary to select from a filtered commit list
+	 *
+	 * @param DataList $commits List of commits
+	 * @return FormField
+	 */
+	protected function buildPipelineField($commits)
+	{
+		// Get filtered commits
+		$filteredCommits = array();
+		foreach ($commits as $commit) {
+			$title = sprintf(
+				"%s (%s, %s old)",
+				$commit->Message,
+				substr($commit->SHA, 0, 8),
+				$commit->dbObject('Created')->TimeDiff()
+			);
+			$filteredCommits[$commit->SHA] = $title;
+		}
+		if ($filteredCommits) {
+			return new DropdownField('FilteredCommits', '', $filteredCommits);
+		} else {
+			return DropdownField::create('FilteredCommits)', '')
+				->setEmptyString('No deployments available')
+				->performDisabledTransformation();
+		}
+	}
 
-    /**
-     * Get the build selected from the given data
-     *
-     * @param array $data
-     * @return string SHA of selected build
-     */
-    public function getSelectedBuild($data)
-    {
-        if (isset($data['SelectRelease']) && !empty($data[$data['SelectRelease']])) {
-            // Filter out the tag/branch name if required
-            $array = explode('-', $data[$data['SelectRelease']]);
-            return reset($array);
-        }
-        if (isset($data['FilteredCommits']) && !empty($data['FilteredCommits'])) {
-            return $data['FilteredCommits'];
-        }
-    }
+	/**
+	 * Get the build selected from the given data
+	 *
+	 * @param array $data
+	 * @return string SHA of selected build
+	 */
+	public function getSelectedBuild($data)
+	{
+		if (isset($data['SelectRelease']) && !empty($data[$data['SelectRelease']])) {
+			// Filter out the tag/branch name if required
+			$array = explode('-', $data[$data['SelectRelease']]);
+			return reset($array);
+		}
+		if (isset($data['FilteredCommits']) && !empty($data['FilteredCommits'])) {
+			return $data['FilteredCommits'];
+		}
+	}
 }

Spacing +22 added lines, -22 removed lines

@@ -31,7 +31,7 @@ 
     protected function validateCommit($sha, $field)
     {
         // Check selected commit
-        if (empty($sha)) {
+        if(empty($sha)) {
             $this->validationError(
                 $field,
                 "No valid release selected",
@@ -41,7 +41,7 @@ 
         }
 
         // Check validity of commit
-        if (!preg_match('/^[a-f0-9]{40}$/', $sha)) {
+        if(!preg_match('/^[a-f0-9]{40}$/', $sha)) {
             $this->validationError(
                 $field,
                 "Invalid release SHA: " . Convert::raw2xml($sha),
@@ -66,7 +66,7 @@ 
     public function php($data)
     {
         // Check release method
-        if (empty($data['SelectRelease'])
+        if(empty($data['SelectRelease'])
             || !in_array($data['SelectRelease'], array('Tag', 'Branch', 'Redeploy', 'SHA', 'FilteredCommits'))
         ) {
             $method = empty($data['SelectRelease']) ? '(blank)' : $data['SelectRelease'];
@@ -121,7 +121,7 @@ 
      */
     public function __construct($controller, $name, DNEnvironment $environment, DNProject $project)
     {
-        if ($environment->HasPipelineSupport()) {
+        if($environment->HasPipelineSupport()) {
             list($field, $validator, $actions) = $this->setupPipeline($environment, $project);
         } else {
             list($field, $validator, $actions) = $this->setupSimpleDeploy($project);
@@ -159,11 +159,11 @@ 
         $canBypass = Permission::check(DNRoot::DEPLOYNAUT_BYPASS_PIPELINE);
         $canDryrun = $environment->DryRunEnabled && Permission::check(DNRoot::DEPLOYNAUT_DRYRUN_PIPELINE);
         $commits = $environment->getDependentFilteredCommits();
-        if (empty($commits)) {
+        if(empty($commits)) {
             // There are no filtered commits, so show all commits
             $field = $this->buildCommitSelector($project);
             $validator = new DeployForm_CommitValidator();
-        } elseif ($canBypass) {
+        } elseif($canBypass) {
             // Build hybrid selector that allows users to follow pipeline or use any commit
             $field = $this->buildCommitSelector($project, $commits);
             $validator = new DeployForm_CommitValidator();
@@ -179,7 +179,7 @@ 
                 ->addExtraClass('btn btn-primary')
                 ->setAttribute('onclick', "return confirm('This will begin a release pipeline. Continue?');")
         );
-        if ($canDryrun) {
+        if($canDryrun) {
             $actions->push(
                 FormAction::create('doDryRun', "Dry-run release process")
                     ->addExtraClass('btn btn-info')
@@ -192,7 +192,7 @@ 
                     )
             );
         }
-        if ($canBypass) {
+        if($canBypass) {
             $actions->push(
                 FormAction::create('showDeploySummary', "Direct deployment (bypass pipeline)")
                     ->addExtraClass('btn btn-warning')
@@ -218,7 +218,7 @@ 
     {
         // Branches
         $branches = array();
-        foreach ($project->DNBranchList() as $branch) {
+        foreach($project->DNBranchList() as $branch) {
             $sha = $branch->SHA();
             $name = $branch->Name();
             $branchValue = sprintf("%s (%s, %s old)",
@@ -231,7 +231,7 @@ 
 
         // Tags
         $tags = array();
-        foreach ($project->DNTagList()->setLimit(null) as $tag) {
+        foreach($project->DNTagList()->setLimit(null) as $tag) {
             $sha = $tag->SHA();
             $name = $tag->Name();
             $tagValue = sprintf("%s (%s, %s old)",
@@ -245,14 +245,14 @@ 
 
         // Past deployments
         $redeploy = array();
-        foreach ($project->DNEnvironmentList() as $dnEnvironment) {
+        foreach($project->DNEnvironmentList() as $dnEnvironment) {
             $envName = $dnEnvironment->Name;
-            foreach ($dnEnvironment->DeployHistory() as $deploy) {
+            foreach($dnEnvironment->DeployHistory() as $deploy) {
                 $sha = $deploy->SHA;
-                if (!isset($redeploy[$envName])) {
+                if(!isset($redeploy[$envName])) {
                     $redeploy[$envName] = array();
                 }
-                if (!isset($redeploy[$envName][$sha])) {
+                if(!isset($redeploy[$envName][$sha])) {
                     $pastValue = sprintf("%s (deployed %s)",
                         substr($sha, 0, 8),
                         $deploy->obj('LastEdited')->Ago()
@@ -264,28 +264,28 @@ 
 
         // Merge fields
         $releaseMethods = array();
-        if ($pipelineCommits) {
+        if($pipelineCommits) {
             $releaseMethods[] = new SelectionGroup_Item(
                 'FilteredCommits',
                 $this->buildPipelineField($pipelineCommits),
                 'Deploy a commit prepared for this pipeline'
             );
         }
-        if (!empty($branches)) {
+        if(!empty($branches)) {
             $releaseMethods[] = new SelectionGroup_Item(
                 'Branch',
                 new DropdownField('Branch', 'Select a branch', $branches),
                 'Deploy the latest version of a branch'
             );
         }
-        if ($tags) {
+        if($tags) {
             $releaseMethods[] = new SelectionGroup_Item(
                 'Tag',
                 new DropdownField('Tag', 'Select a tag', $tags),
                 'Deploy a tagged release'
             );
         }
-        if ($redeploy) {
+        if($redeploy) {
             $releaseMethods[] = new SelectionGroup_Item(
                 'Redeploy',
                 new GroupedDropdownField('Redeploy', 'Redeploy', $redeploy),
@@ -314,7 +314,7 @@ 
     {
         // Get filtered commits
         $filteredCommits = array();
-        foreach ($commits as $commit) {
+        foreach($commits as $commit) {
             $title = sprintf(
                 "%s (%s, %s old)",
                 $commit->Message,
@@ -323,7 +323,7 @@ 
             );
             $filteredCommits[$commit->SHA] = $title;
         }
-        if ($filteredCommits) {
+        if($filteredCommits) {
             return new DropdownField('FilteredCommits', '', $filteredCommits);
         } else {
             return DropdownField::create('FilteredCommits)', '')
@@ -340,12 +340,12 @@ 
      */
     public function getSelectedBuild($data)
     {
-        if (isset($data['SelectRelease']) && !empty($data[$data['SelectRelease']])) {
+        if(isset($data['SelectRelease']) && !empty($data[$data['SelectRelease']])) {
             // Filter out the tag/branch name if required
             $array = explode('-', $data[$data['SelectRelease']]);
             return reset($array);
         }
-        if (isset($data['FilteredCommits']) && !empty($data['FilteredCommits'])) {
+        if(isset($data['FilteredCommits']) && !empty($data['FilteredCommits'])) {
             return $data['FilteredCommits'];
         }
     }

Braces +14 added lines, -28 removed lines

@@ -6,16 +6,14 @@ 
  * @package deploynaut
  * @subpackage control
  */
-abstract class DeployForm_ValidatorBase extends Validator
-{
+abstract class DeployForm_ValidatorBase extends Validator {
 
     /**
      * @param string $fieldName
      * @param string $message
      * @param string $messageType
      */
-    public function validationError($fieldName, $message, $messageType = '')
-    {
+    public function validationError($fieldName, $message, $messageType = '') {
         // Just make any error use the form message
         $this->form->sessionMessage($message, $messageType);
         parent::validationError($fieldName, $message, $messageType);
@@ -28,8 +26,7 @@ 
      * @param string $field
      * @return boolean
      */
-    protected function validateCommit($sha, $field)
-    {
+    protected function validateCommit($sha, $field) {
         // Check selected commit
         if (empty($sha)) {
             $this->validationError(
@@ -60,11 +57,9 @@ 
  * @package deploynaut
  * @subpackage control
  */
-class DeployForm_CommitValidator extends DeployForm_ValidatorBase
-{
+class DeployForm_CommitValidator extends DeployForm_ValidatorBase {
 
-    public function php($data)
-    {
+    public function php($data) {
         // Check release method
         if (empty($data['SelectRelease'])
             || !in_array($data['SelectRelease'], array('Tag', 'Branch', 'Redeploy', 'SHA', 'FilteredCommits'))
@@ -92,11 +87,9 @@ 
  * @package deploynaut
  * @subpackage control
  */
-class DeployForm_PipelineValidator extends DeployForm_ValidatorBase
-{
+class DeployForm_PipelineValidator extends DeployForm_ValidatorBase {
 
-    public function php($data)
-    {
+    public function php($data) {
         return $this->validateCommit(
             $this->form->getSelectedBuild($data),
             'FilteredCommits'
@@ -110,8 +103,7 @@ 
  * @package deploynaut
  * @subpackage control
  */
-class DeployForm extends Form
-{
+class DeployForm extends Form {
 
     /**
      * @param DNRoot $controller
@@ -119,8 +111,7 @@ 
      * @param DNEnvironment $environment
      * @param DNProject $project
      */
-    public function __construct($controller, $name, DNEnvironment $environment, DNProject $project)
-    {
+    public function __construct($controller, $name, DNEnvironment $environment, DNProject $project) {
         if ($environment->HasPipelineSupport()) {
             list($field, $validator, $actions) = $this->setupPipeline($environment, $project);
         } else {
@@ -134,8 +125,7 @@ 
      *
      * @return array
      */
-    protected function setupSimpleDeploy(DNProject $project)
-    {
+    protected function setupSimpleDeploy(DNProject $project) {
         // without a pipeline simply allow any commit to be selected
         $field = $this->buildCommitSelector($project);
         $validator = new DeployForm_CommitValidator();
@@ -153,8 +143,7 @@ 
      * @return array
      * @throws Exception
      */
-    protected function setupPipeline(DNEnvironment $environment, DNProject $project)
-    {
+    protected function setupPipeline(DNEnvironment $environment, DNProject $project) {
         // Determine if commits are filtered
         $canBypass = Permission::check(DNRoot::DEPLOYNAUT_BYPASS_PIPELINE);
         $canDryrun = $environment->DryRunEnabled && Permission::check(DNRoot::DEPLOYNAUT_DRYRUN_PIPELINE);
@@ -214,8 +203,7 @@ 
      * @param DataList|null $pipelineCommits Optional list of pipeline-filtered commits to include
      * @return FormField
      */
-    protected function buildCommitSelector($project, $pipelineCommits = null)
-    {
+    protected function buildCommitSelector($project, $pipelineCommits = null) {
         // Branches
         $branches = array();
         foreach ($project->DNBranchList() as $branch) {
@@ -310,8 +298,7 @@ 
      * @param DataList $commits List of commits
      * @return FormField
      */
-    protected function buildPipelineField($commits)
-    {
+    protected function buildPipelineField($commits) {
         // Get filtered commits
         $filteredCommits = array();
         foreach ($commits as $commit) {
@@ -338,8 +325,7 @@ 
      * @param array $data
      * @return string SHA of selected build
      */
-    public function getSelectedBuild($data)
-    {
+    public function getSelectedBuild($data) {
         if (isset($data['SelectRelease']) && !empty($data[$data['SelectRelease']])) {
             // Filter out the tag/branch name if required
             $array = explode('-', $data[$data['SelectRelease']]);

code/control/DeploynautLogFile.php

Indentation +100 added lines, -100 removed lines

@@ -6,104 +6,104 @@
 class DeploynautLogFile
 {
 
-    protected $logFile;
-
-    protected $basePath;
-
-    /**
-     * @param string $logFile The log filename
-     * @param string|null $basePath Base path of where logs reside. Defaults to DEPLOYNAUT_LOG_PATH
-     */
-    public function __construct($logFile, $basePath = null)
-    {
-        $this->logFile = $logFile;
-        $this->basePath = $basePath ?: DEPLOYNAUT_LOG_PATH;
-    }
-
-    /**
-     * Set the log filename
-     * @param string $filename
-     */
-    public function setLogFile($filename)
-    {
-        $this->logFile = $filename;
-    }
-
-    /**
-     * Set the base path of where logs reside
-     * @param string $path
-     */
-    public function setBasePath($path)
-    {
-        $this->basePath = $path;
-    }
-
-    /**
-     * Return the un-sanitised log path.
-     * @return string
-     */
-    public function getRawFilePath()
-    {
-        return $this->basePath . '/' . $this->logFile;
-    }
-
-    /**
-     * Get the sanitised log path.
-     * @return string
-     */
-    public function getSanitisedLogFilePath()
-    {
-        return $this->basePath . '/' . strtolower(FileNameFilter::create()->filter($this->logFile));
-    }
-
-    /**
-     * Return log file path, assuming it exists. Returns NULL if nothing found.
-     * @return string|null
-     */
-    public function getLogFilePath()
-    {
-        $path = $this->getSanitisedLogFilePath();
-
-        // for backwards compatibility on old logs
-        if (!file_exists($path)) {
-            $path = $this->getRawFilePath();
-
-            if (!file_exists($path)) {
-                return null;
-            }
-        }
-
-        return $path;
-    }
-
-    /**
-     * Write a message line into the log file.
-     * @param string $message
-     */
-    public function write($message)
-    {
-        // Make sure we write into the old path for existing logs. New logs use the sanitised file path instead.
-        $path = file_exists($this->getRawFilePath()) ? $this->getRawFilePath() : $this->getSanitisedLogFilePath();
-
-        error_log('['.date('Y-m-d H:i:s').'] ' . $message .PHP_EOL, 3, $path);
-        @chmod($path, 0666);
-    }
-
-    /**
-     * Does the log file exist?
-     * @return bool
-     */
-    public function exists()
-    {
-        return (bool)$this->getLogFilePath();
-    }
-
-    /**
-     * Return the content of the log file.
-     * @return string
-     */
-    public function content()
-    {
-        return $this->exists() ? file_get_contents($this->getLogFilePath()) : 'Log has not been created yet.';
-    }
+	protected $logFile;
+
+	protected $basePath;
+
+	/**
+	 * @param string $logFile The log filename
+	 * @param string|null $basePath Base path of where logs reside. Defaults to DEPLOYNAUT_LOG_PATH
+	 */
+	public function __construct($logFile, $basePath = null)
+	{
+		$this->logFile = $logFile;
+		$this->basePath = $basePath ?: DEPLOYNAUT_LOG_PATH;
+	}
+
+	/**
+	 * Set the log filename
+	 * @param string $filename
+	 */
+	public function setLogFile($filename)
+	{
+		$this->logFile = $filename;
+	}
+
+	/**
+	 * Set the base path of where logs reside
+	 * @param string $path
+	 */
+	public function setBasePath($path)
+	{
+		$this->basePath = $path;
+	}
+
+	/**
+	 * Return the un-sanitised log path.
+	 * @return string
+	 */
+	public function getRawFilePath()
+	{
+		return $this->basePath . '/' . $this->logFile;
+	}
+
+	/**
+	 * Get the sanitised log path.
+	 * @return string
+	 */
+	public function getSanitisedLogFilePath()
+	{
+		return $this->basePath . '/' . strtolower(FileNameFilter::create()->filter($this->logFile));
+	}
+
+	/**
+	 * Return log file path, assuming it exists. Returns NULL if nothing found.
+	 * @return string|null
+	 */
+	public function getLogFilePath()
+	{
+		$path = $this->getSanitisedLogFilePath();
+
+		// for backwards compatibility on old logs
+		if (!file_exists($path)) {
+			$path = $this->getRawFilePath();
+
+			if (!file_exists($path)) {
+				return null;
+			}
+		}
+
+		return $path;
+	}
+
+	/**
+	 * Write a message line into the log file.
+	 * @param string $message
+	 */
+	public function write($message)
+	{
+		// Make sure we write into the old path for existing logs. New logs use the sanitised file path instead.
+		$path = file_exists($this->getRawFilePath()) ? $this->getRawFilePath() : $this->getSanitisedLogFilePath();
+
+		error_log('['.date('Y-m-d H:i:s').'] ' . $message .PHP_EOL, 3, $path);
+		@chmod($path, 0666);
+	}
+
+	/**
+	 * Does the log file exist?
+	 * @return bool
+	 */
+	public function exists()
+	{
+		return (bool)$this->getLogFilePath();
+	}
+
+	/**
+	 * Return the content of the log file.
+	 * @return string
+	 */
+	public function content()
+	{
+		return $this->exists() ? file_get_contents($this->getLogFilePath()) : 'Log has not been created yet.';
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -65,10 +65,10 @@ 
         $path = $this->getSanitisedLogFilePath();
 
         // for backwards compatibility on old logs
-        if (!file_exists($path)) {
+        if(!file_exists($path)) {
             $path = $this->getRawFilePath();
 
-            if (!file_exists($path)) {
+            if(!file_exists($path)) {
                 return null;
             }
         }
@@ -85,7 +85,7 @@ 
         // Make sure we write into the old path for existing logs. New logs use the sanitised file path instead.
         $path = file_exists($this->getRawFilePath()) ? $this->getRawFilePath() : $this->getSanitisedLogFilePath();
 
-        error_log('['.date('Y-m-d H:i:s').'] ' . $message .PHP_EOL, 3, $path);
+        error_log('[' . date('Y-m-d H:i:s') . '] ' . $message . PHP_EOL, 3, $path);
         @chmod($path, 0666);
     }
 

Braces +10 added lines, -20 removed lines

@@ -3,8 +3,7 @@ 
 /**
  * Simple support class for reading and writing deploynaut job logs
  */
-class DeploynautLogFile
-{
+class DeploynautLogFile {
 
     protected $logFile;
 
@@ -14,8 +13,7 @@ 
      * @param string $logFile The log filename
      * @param string|null $basePath Base path of where logs reside. Defaults to DEPLOYNAUT_LOG_PATH
      */
-    public function __construct($logFile, $basePath = null)
-    {
+    public function __construct($logFile, $basePath = null) {
         $this->logFile = $logFile;
         $this->basePath = $basePath ?: DEPLOYNAUT_LOG_PATH;
     }
@@ -24,8 +22,7 @@ 
      * Set the log filename
      * @param string $filename
      */
-    public function setLogFile($filename)
-    {
+    public function setLogFile($filename) {
         $this->logFile = $filename;
     }
 
@@ -33,8 +30,7 @@ 
      * Set the base path of where logs reside
      * @param string $path
      */
-    public function setBasePath($path)
-    {
+    public function setBasePath($path) {
         $this->basePath = $path;
     }
 
@@ -42,8 +38,7 @@ 
      * Return the un-sanitised log path.
      * @return string
      */
-    public function getRawFilePath()
-    {
+    public function getRawFilePath() {
         return $this->basePath . '/' . $this->logFile;
     }
 
@@ -51,8 +46,7 @@ 
      * Get the sanitised log path.
      * @return string
      */
-    public function getSanitisedLogFilePath()
-    {
+    public function getSanitisedLogFilePath() {
         return $this->basePath . '/' . strtolower(FileNameFilter::create()->filter($this->logFile));
     }
 
@@ -60,8 +54,7 @@ 
      * Return log file path, assuming it exists. Returns NULL if nothing found.
      * @return string|null
      */
-    public function getLogFilePath()
-    {
+    public function getLogFilePath() {
         $path = $this->getSanitisedLogFilePath();
 
         // for backwards compatibility on old logs
@@ -80,8 +73,7 @@ 
      * Write a message line into the log file.
      * @param string $message
      */
-    public function write($message)
-    {
+    public function write($message) {
         // Make sure we write into the old path for existing logs. New logs use the sanitised file path instead.
         $path = file_exists($this->getRawFilePath()) ? $this->getRawFilePath() : $this->getSanitisedLogFilePath();
 
@@ -93,8 +85,7 @@ 
      * Does the log file exist?
      * @return bool
      */
-    public function exists()
-    {
+    public function exists() {
         return (bool)$this->getLogFilePath();
     }
 
@@ -102,8 +93,7 @@ 
      * Return the content of the log file.
      * @return string
      */
-    public function content()
-    {
+    public function content() {
         return $this->exists() ? file_get_contents($this->getLogFilePath()) : 'Log has not been created yet.';
     }
 }