Merge branch 'refs/heads/1.1.0' into 1.1

Author: Florian Krämer

src/Storage/PathBuilder/BasePathBuilder.php

@@ -257,16 +257,16 @@ public function fullPath(EntityInterface $entity, array $options = []) {
 		return $this->path($entity, $options) . $this->filename($entity, $options);
 	}
 
-/**
- * Builds the URL under which the file is accessible.
- *
- * This is for example important for S3 and Dropbox but also the Local adapter
- * if you symlink a folder to your webroot and allow direct access to a file.
- *
- * @param \Cake\Datasource\EntityInterface $entity
- * @param array $options
- * @return string
- */
+	/**
+	 * Builds the URL under which the file is accessible.
+	 *
+	 * This is for example important for S3 and Dropbox but also the Local adapter
+	 * if you symlink a folder to your webroot and allow direct access to a file.
+	 *
+	 * @param \Cake\Datasource\EntityInterface $entity
+	 * @param array $options
+	 * @return string
+	 */
 	public function url(EntityInterface $entity, array $options = []) {
 		$url = $this->path($entity, $options) . $this->filename($entity, $options);
 		return str_replace('\\', '/', $url);
@@ -280,6 +280,7 @@ public function url(EntityInterface $entity, array $options = []) {
 	 * @param string $string Input string
 	 * @param int $level Depth of the path to generate.
 	 * @param string $method Hash method, crc32 or sha1.
+	 * @throws \InvalidArgumentException
 	 * @return string
 	 */
 	public function randomPath($string, $level = 3, $method = 'sha1') {
@@ -293,6 +294,7 @@ public function randomPath($string, $level = 3, $method = 'sha1') {
 		if (method_exists($this, $method)) {
 			return $this->{$method}($string, $level);
 		}
+		throw new \InvalidArgumentException(sprintf('BasepathBuilder::randomPath() invalid hash `%s` method provided!', $method));
 	}
 
 	/**
@@ -301,6 +303,7 @@ public function randomPath($string, $level = 3, $method = 'sha1') {
 	 * Please STOP USING CR32! See the huge warning on the php documentation page.
 	 * of the crc32() function.
 	 *
+	 * @deprecated Stop using it, see the methods doc block for more info.
 	 * @link http://php.net/manual/en/function.crc32.php
 	 * @link https://www.box.com/blog/crc32-checksums-the-good-the-bad-and-the-ugly/
 	 * @param string $string Input string

src/Storage/StorageUtils.php

@@ -161,11 +161,11 @@ public static function ksortRecursive(&$array, $sortFlags = SORT_REGULAR) {
 	/**
 	 * Returns an array that matches the structure of a regular upload for a local file
 	 *
-	 * @param $file
-	 * @param string File with path
+	 * @param $file The file you want to get an upload array for.
+	 * @param string Name of the file to use in the upload array.
 	 * @return array Array that matches the structure of a regular upload
 	 */
-	public static function uploadArray($file, $filename = null) {
+	public static function fileToUploadArray($file, $filename = null) {
 		$File = new File($file);
 		if (empty($fileName)) {
 			$filename = basename($file);
@@ -179,6 +179,17 @@ public static function uploadArray($file, $filename = null) {
 		];
 	}
 
+	/**
+	 * Convenience alias for fileToUploadArray
+	 *
+	 * @param $file
+	 * @param string File with path
+	 * @return array Array that matches the structure of a regular upload
+	 */
+	public static function uploadArray($file, $filename = null) {
+		return self::fileToUploadArray($file, $filename);
+	}
+
 	/**
 	 * Gets the hash of a file.
 	 *

tests/TestCase/Storage/PathBuilder/BasePathBuilderTest.php

@@ -6,13 +6,23 @@
 use Cake\ORM\TableRegistry;
 use Cake\TestSuite\TestCase;
 
+class TestBasePathBuilder extends BasePathBuilder {
+
+	/**
+	 *
+	 */
+	public function randomPathTestMethod($string) {
+		return $string . 'test';
+	}
+}
+
 class BasePathBuilderTest extends TestCase {
 
-/**
- * Fixtures
- *
- * @var array
- */
+	/**
+	 * Fixtures
+	 *
+	 * @var array
+	 */
 	public $fixtures = array(
 		'plugin.Burzum\FileStorage.FileStorage'
 	);
@@ -36,11 +46,11 @@ public function setUp() {
 		$this->entity->accessible('id', true);
 	}
 
-/**
- * testPathbuilding
- *
- * @return void
- */
+	/**
+	 * testPathbuilding
+	 *
+	 * @return void
+	 */
 	public function testPathbuilding() {
 		$builder = new BasePathBuilder();
 		$config = $builder->config();
@@ -73,30 +83,60 @@ public function testPathbuilding() {
 		$result = $builder->path($this->entity);
 		$this->assertEquals($result, '14' . DS . '83' . DS . '23' . DS . 'filestorage1' . DS . 'files' . DS);
 
+		$builder->config($config);
+		$builder->config('pathPrefix', 'files');
+		$result = $builder->path($this->entity);
+		$this->assertEquals($result, 'files' . DS . '14' . DS . '83' . DS . '23' . DS . 'filestorage1' . DS);
+
+		$builder->config($config);
 		$result = $builder->url($this->entity);
-		$expected = '14/83/23/filestorage1/files/filestorage1.png';
+		$expected = '14/83/23/filestorage1/filestorage1.png';
 		$this->assertEquals($result, $expected);
 	}
 
-/**
- * testRandomPath
- *
- * @return void
- */
+	/**
+	 * testRandomPath
+	 *
+	 * @return void
+	 */
 	public function testRandomPath() {
-		$builder = new BasePathBuilder();
+		$builder = new TestBasePathBuilder();
 		$result = $builder->randomPath('test', 5, 'sha1');
 		$this->assertEquals($result, '4a' . DS . '8f' . DS . 'e5' . DS . 'cc' . DS . 'b1' . DS);
 
 		$result = $builder->randomPath('test', 3, 'sha1');
 		$this->assertEquals($result, '4a' . DS . '8f' . DS . 'e5' . DS);
+
+		if (PHP_INT_SIZE === 4) {
+			$result = $builder->randomPath('test', 3, 'crc32');
+			$this->assertEquals($result, '00' . DS . '33' . DS . '73' . DS);
+		}
+
+		if (PHP_INT_SIZE === 8) {
+			$result = $builder->randomPath('test', 3, 'crc32');
+			$this->assertEquals($result, '96' . DS . '39' . DS . '23' . DS);
+		}
+
+		$result = $builder->randomPath('test', 3, 'randomPathTestMethod');
+		$this->assertEquals($result, 'testtest');
+	}
+
+	/**
+	 * testRandomPathInvalidArgumentException
+	 *
+	 * @expectedException \InvalidArgumentException
+	 * @return void
+	 */
+	public function testRandomPathInvalidArgumentException() {
+		$builder = new BasePathBuilder();
+		$result = $builder->randomPath('test', 5, 'does-not-exist');
 	}
 
-/**
- * testEnsureSlash
- *
- * @return void
- */
+	/**
+	 * testEnsureSlash
+	 *
+	 * @return void
+	 */
 	public function testEnsureSlash() {
 		$string = 'foo/bar';
 		$builder = new BasePathBuilder();
@@ -107,22 +147,22 @@ public function testEnsureSlash() {
 		$this->assertEquals($result, DS . $string . DS);
 	}
 
-/**
- * testEnsureSlashInvalidArgumentException
- *
- * @expectedException \InvalidArgumentException
- */
+	/**
+	 * testEnsureSlashInvalidArgumentException
+	 *
+	 * @expectedException \InvalidArgumentException
+	 */
 	public function testEnsureSlashInvalidArgumentException() {
 		$string = 'foo/bar';
 		$builder = new BasePathBuilder();
 		$builder->ensureSlash($string, 'INVALID!');
 	}
 
-/**
- * testSplitFilename
- *
- * @return void
- */
+	/**
+	 * testSplitFilename
+	 *
+	 * @return void
+	 */
 	public function testSplitFilename() {
 		$builder = new BasePathBuilder();
 		$result = $builder->splitFilename('some.fancy.name.jpg');
@@ -140,11 +180,11 @@ public function testSplitFilename() {
 		$this->assertEquals($result, $expected);
 	}
 
-/**
- * testStripDashes
- *
- * @return void
- */
+	/**
+	 * testStripDashes
+	 *
+	 * @return void
+	 */
 	public function testStripDashes() {
 		$builder = new BasePathBuilder();
 		$result = $builder->stripDashes('with-dashes-!');