Create a new class for getting new names of files plus a test class in preperation for refactoring

Author: dmanners

lib/internal/Magento/Framework/File/Name.php

@@ -0,0 +1,64 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Framework\File;
+
+use Magento\Framework\App\Filesystem\DirectoryList;
+use Magento\Framework\Exception\FileSystemException;
+use Magento\Framework\Validation\ValidationException;
+
+/**
+ * Class Name
+ *
+ * @package Magento\Framework\File
+ */
+class Name
+{
+    /**
+     * Get new file name if the given name is in use
+     *
+     * @param string $destinationFile
+     * @return string
+     */
+    public function getNewFileName(string $destinationFile)
+    {
+        $fileInfo = $this->getPathInfo($destinationFile);
+        if ($this->fileExist($destinationFile)) {
+            $index = 1;
+            $baseName = $fileInfo['filename'] . '.' . $fileInfo['extension'];
+            while (file_exists($fileInfo['dirname'] . '/' . $baseName)) {
+                $baseName = $fileInfo['filename'] . '_' . $index . '.' . $fileInfo['extension'];
+                $index++;
+            }
+            $destFileName = $baseName;
+        } else {
+            return $fileInfo['basename'];
+        }
+
+        return $destFileName;
+    }
+
+    /**
+     * Get the path information from a given file
+     *
+     * @param string $destinationFile
+     * @return string|string[]
+     */
+    private function getPathInfo(string $destinationFile)
+    {
+        return pathinfo($destinationFile);
+    }
+
+    /**
+     * Check to see if a given file exists
+     *
+     * @param string $destinationFile
+     * @return bool
+     */
+    private function fileExist(string $destinationFile)
+    {
+        return file_exists($destinationFile);
+    }
+}

lib/internal/Magento/Framework/Test/Unit/File/NameTest.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Framework\Test\Unit\File;
+
+use Magento\Framework\File\Name;
+
+class NameTest extends \PHPUnit\Framework\TestCase
+{
+    /**
+     * @var string
+     */
+    private $existingFilePath;
+
+    /**
+     * @var string
+     */
+    private $nonExistingFilePath;
+
+    /**
+     * @var Name
+     */
+    private $name;
+
+    protected function setUp()
+    {
+        $this->name = new Name();
+        $this->existingFilePath = __DIR__ . '/../_files/source.txt';
+        $this->nonExistingFilePath = __DIR__ . '/../_files/file.txt';
+    }
+
+    /**
+     * @test
+     */
+    public function testGetNewFileNameWhenFileExists()
+    {
+        $this->assertEquals('source_1.txt', $this->name->getNewFileName($this->existingFilePath));
+    }
+
+    /**
+     * @test
+     */
+    public function testGetNewFileNameWhenFileDoesNotExist()
+    {
+        $this->assertEquals('file.txt', $this->name->getNewFileName($this->nonExistingFilePath));
+    }
+}