Make working directory sub-folder configurable (was ".svn-buddy" hardcoded before) via DIC

Author: Alexander Obuhovich

phpunit.xml.dist

@@ -27,6 +27,10 @@
 			 lowUpperBound="35" highLowerBound="70"/>
 	</logging>-->
 
+	<php>
+		<server name="working_directory" value=".svn-buddy"/>
+	</php>
+
 	<filter>
 		<whitelist>
             <directory>src/SVNBuddy</directory>

src/SVNBuddy/DIContainer.php

@@ -37,16 +37,17 @@ public function __construct(array $values = array())
 	{
 		parent::__construct($values);
 
-		$this['configFile'] = '{base}/config.json';
+		$this['config_file'] = '{base}/config.json';
+		$this['working_directory_sub_folder'] = '.svn-buddy';
 
-		$this['working_directory'] = function () {
-			$working_directory = new WorkingDirectory();
+		$this['working_directory'] = function ($c) {
+			$working_directory = new WorkingDirectory($c['working_directory_sub_folder']);
 
 			return $working_directory->get();
 		};
 
 		$this['config_editor'] = function ($c) {
-			return new ConfigEditor(str_replace('{base}', $c['working_directory'], $c['configFile']));
+			return new ConfigEditor(str_replace('{base}', $c['working_directory'], $c['config_file']));
 		};
 
 		$this['input'] = function () {

src/SVNBuddy/WorkingDirectory.php

@@ -16,14 +16,37 @@
 class WorkingDirectory
 {
 
+	/**
+	 * Name of sub folder placed in user's home directory.
+	 *
+	 * @var string
+	 */
+	private $_subFolder;
+
+	/**
+	 * WorkingDirectory constructor.
+	 *
+	 * @param string $sub_folder Sub folder.
+	 *
+	 * @throws ApplicationException When $sub_folder is a path or empty.
+	 */
+	public function __construct($sub_folder)
+	{
+		if ( !strlen($sub_folder) || strpos($sub_folder, DIRECTORY_SEPARATOR) !== false ) {
+			throw new ApplicationException('The $sub_folder is a path or empty.');
+		}
+
+		$this->_subFolder = $sub_folder;
+	}
+
 	/**
 	 * Creates (if missing) working directory and returns full path to it.
 	 *
 	 * @return string
 	 */
 	public function get()
 	{
-		$working_directory = $this->getUserHomeDirectory() . '/.svn-buddy';
+		$working_directory = $this->getUserHomeDirectory() . '/' . $this->_subFolder;
 
 		if ( !file_exists($working_directory) ) {
 			mkdir($working_directory, 0777, true);

tests/SVNBuddy/WorkingDirectoryAwareTestCase.php

@@ -16,19 +16,10 @@
 abstract class WorkingDirectoryAwareTestCase extends \PHPUnit_Framework_TestCase
 {
 
-	/**
-	 * Original value of "HOME" environment variable.
-	 *
-	 * @var string
-	 */
-	private $_homeDirectoryBackup;
-
 	protected function setUp()
 	{
 		parent::setUp();
 
-		$this->_homeDirectoryBackup = getenv('HOME');
-
 		if ( $this->requireWorkingDirectory() ) {
 			$this->_createTempHomeDirectory();
 		}
@@ -51,7 +42,13 @@ protected function requireWorkingDirectory()
 	 */
 	protected function getWorkingDirectory()
 	{
-		$working_directory = new WorkingDirectory();
+		$sub_folder = array_key_exists('working_directory', $_SERVER) ? $_SERVER['working_directory'] : '';
+
+		if ( !strlen($sub_folder) ) {
+			$this->fail('Please set "working_directory" environment variable before calling ' . __METHOD__ . '.');
+		}
+
+		$working_directory = new WorkingDirectory($sub_folder);
 
 		return $working_directory->get();
 	}
@@ -60,7 +57,7 @@ protected function tearDown()
 	{
 		parent::tearDown();
 
-		$this->_restoreHomeDirectory($this->_homeDirectoryBackup);
+		$this->_restoreHomeDirectory();
 	}
 
 	/**
@@ -80,10 +77,17 @@ private function _createTempHomeDirectory()
 	/**
 	 * Restores original home directory and removes temporary one.
 	 *
-	 * @param string $original_home_directory Directory.
+	 * @return void
+	 * @throws \LogicException When original home directory is empty.
 	 */
-	private function _restoreHomeDirectory($original_home_directory)
+	private function _restoreHomeDirectory()
 	{
+		$original_home_directory = $_SERVER['HOME'];
+
+		if ( empty($original_home_directory) ) {
+			throw new \LogicException('Unable to restore empty home directory.');
+		}
+
 		$current_home_directory = getenv('HOME');
 
 		if ( $current_home_directory && $current_home_directory != $original_home_directory ) {

tests/SVNBuddy/WorkingDirectoryTest.php

@@ -11,9 +11,29 @@
 namespace Tests\aik099\SVNBuddy;
 
 
+use aik099\SVNBuddy\WorkingDirectory;
+
 class WorkingDirectoryTest extends WorkingDirectoryAwareTestCase
 {
 
+	/**
+	 * @expectedException \aik099\SVNBuddy\Exception\ApplicationException
+	 * @expectedExceptionMessage The $sub_folder is a path or empty.
+	 * @dataProvider incorrectSubFolderDataProvider
+	 */
+	public function testCreationWithIncorrectSubFolder($sub_folder)
+	{
+		new WorkingDirectory($sub_folder);
+	}
+
+	public function incorrectSubFolderDataProvider()
+	{
+		return array(
+			'empty sub-folder' => array(''),
+			'path sub-folder' => array('a/b'),
+		);
+	}
+
 	public function testWorkingDirectoryCreation()
 	{
 		$expected_working_directory = $this->getExpectedWorkingDirectory();
@@ -56,7 +76,9 @@ public function testBrokenWindowsEnvironment()
 	 */
 	protected function getExpectedWorkingDirectory()
 	{
-		return getenv('HOME') . '/.svn-buddy';
+		$sub_folder = array_key_exists('working_directory', $_SERVER) ? $_SERVER['working_directory'] : '';
+
+		return getenv('HOME') . '/' . $sub_folder;
 	}
 
 }