[RFT] Code improvements, comments, and tests

Code improvements to increase performance. Additional tests and
comments.

refs KIME-4583

Classes/WE/SpreadsheetImport/Domain/Model/SpreadsheetImport.php

@@ -166,7 +166,11 @@ class SpreadsheetImport {
 	 * @return array
 	 */
 	public function getArguments() {
-		return unserialize($this->arguments);
+		$arguments = unserialize($this->arguments);
+		if (! is_array($arguments)) {
+			$arguments = array();
+		}
+		return $arguments;
 	}
 
 	/**

Configuration/Testing/Settings.yaml

 WE:
   SpreadsheetImport:
     testing:
-      domain: WE\SpreadsheetImport\Tests\Functional\Fixtures\ImportTarget
-      arguments: ~
+      domain: WE\SpreadsheetImport\Tests\Functional\Fixtures\Domain\Model\ImportTarget
+      arguments:
+        - { name: category, domain: 'WE\SpreadsheetImport\Tests\Functional\Fixtures\Domain\Model\ImportTargetCategory', identifier: TRUE }
+        - { name: comment, static: 'Sample import' }

Tests/Functional/Fixtures/Domain/Model/ImportTarget.php

+<?php
+namespace WE\SpreadsheetImport\Tests\Functional\Fixtures\Domain\Model;
+
+/*                                                                        *
+ * This script belongs to the Flow package "SpreadsheetImport".           *
+ *                                                                        *
+ * It is free software; you can redistribute it and/or modify it under    *
+ * the terms of the GNU Lesser General Public License, either version 3   *
+ * of the License, or (at your option) any later version.                 *
+ *                                                                        *
+ * The TYPO3 project - inspiring people to share!                         *
+ *                                                                        */
+
+use TYPO3\Flow\Annotations as Flow;
+use WE\SpreadsheetImport\Annotations as SpreadsheetImport;
+
+/**
+ * @Flow\Entity
+ */
+class ImportTarget {
+
+	/**
+	 * @var string
+	 * @SpreadsheetImport\Mapping(identifier=true, setter="setRawId")
+	 */
+	protected  $id;
+
+	/**
+	 * @var string
+	 * @SpreadsheetImport\Mapping
+	 */
+	protected  $firstName;
+
+	/**
+	 * @var string
+	 * @SpreadsheetImport\Mapping
+	 */
+	protected  $lastName;
+
+	/**
+	 * @var string
+	 * @SpreadsheetImport\Mapping
+	 */
+	protected  $account;
+
+	/**
+	 * @var ImportTargetCategory
+	 */
+	protected  $category;
+
+	/**
+	 * @var string
+	 */
+	protected  $comment;
+
+	/**
+	 * @return string
+	 */
+	public function getId() {
+		return $this->id;
+	}
+
+	/**
+	 * @param string $id
+	 */
+	public function setId($id) {
+		$this->id = $id;
+	}
+
+	/**
+	 * @param string $id
+	 */
+	public function setRawId($id) {
+		$this->id = sprintf('%05d', $id);
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getFirstName() {
+		return $this->firstName;
+	}
+
+	/**
+	 * @param string $firstName
+	 */
+	public function setFirstName($firstName) {
+		$this->firstName = $firstName;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getLastName() {
+		return $this->lastName;
+	}
+
+	/**
+	 * @param string $lastName
+	 */
+	public function setLastName($lastName) {
+		$this->lastName = $lastName;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getAccount() {
+		return $this->account;
+	}
+
+	/**
+	 * @param string $account
+	 */
+	public function setAccount($account) {
+		$this->account = $account;
+	}
+
+	/**
+	 * @return \WE\SpreadsheetImport\Tests\Functional\Fixtures\Domain\Model\ImportTargetCategory
+	 */
+	public function getCategory() {
+		return $this->category;
+	}
+
+	/**
+	 * @param \WE\SpreadsheetImport\Tests\Functional\Fixtures\Domain\Model\ImportTargetCategory $category
+	 */
+	public function setCategory($category) {
+		$this->category = $category;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getComment() {
+		return $this->comment;
+	}
+
+	/**
+	 * @param string $comment
+	 */
+	public function setComment($comment) {
+		$this->comment = $comment;
+	}
+
+}

Tests/Functional/Fixtures/ImportTarget.php → Tests/Functional/Fixtures/Domain/Model/ImportTargetCategory.php

 <?php
-namespace WE\SpreadsheetImport\Tests\Functional\Fixtures;
+namespace WE\SpreadsheetImport\Tests\Functional\Fixtures\Domain\Model;
 
 /*                                                                        *
  * This script belongs to the Flow package "SpreadsheetImport".           *
@@ -13,22 +13,19 @@ namespace WE\SpreadsheetImport\Tests\Functional\Fixtures;
 
 use TYPO3\Flow\Annotations as Flow;
 use WE\SpreadsheetImport\Annotations as SpreadsheetImport;
-use WE\SpreadsheetImport\Domain\Model\SpreadsheetImportTargetInterface;
 
 /**
  * @Flow\Entity
  */
-class ImportTarget {
+class ImportTargetCategory {
 
 	/**
 	 * @var string
-	 * @SpreadsheetImport\Mapping(identifier=true, setter="setRawId")
 	 */
 	protected  $id;
 
 	/**
 	 * @var string
-	 * @SpreadsheetImport\Mapping
 	 */
 	protected  $name;
 
@@ -46,13 +43,6 @@ class ImportTarget {
 		$this->id = $id;
 	}
 
-	/**
-	 * @param string $id
-	 */
-	public function setRawId($id) {
-		$this->id = sprintf('%05d', $id);
-	}
-
 	/**
 	 * @return string
 	 */
@@ -66,4 +56,5 @@ class ImportTarget {
 	public function setName($name) {
 		$this->name = $name;
 	}
+
 }

Tests/Functional/Fixtures/Domain/Repository/ImportTargetRepository.php

+<?php
+namespace WE\SpreadsheetImport\Tests\Functional\Fixtures\Domain\Repository;
+
+/*                                                                        *
+ * This script belongs to the Flow package "SpreadsheetImport".           *
+ *                                                                        *
+ * It is free software; you can redistribute it and/or modify it under    *
+ * the terms of the GNU Lesser General Public License, either version 3   *
+ * of the License, or (at your option) any later version.                 *
+ *                                                                        *
+ * The TYPO3 project - inspiring people to share!                         *
+ *                                                                        */
+
+use TYPO3\Flow\Annotations as Flow;
+use TYPO3\Flow\Persistence\Repository;
+
+/**
+ * @Flow\Scope("singleton")
+ */
+class ImportTargetRepository extends Repository {
+}

Tests/Functional/SpreadsheetImportServiceTest.php

@@ -17,7 +17,8 @@ use TYPO3\Flow\Tests\FunctionalTestCase;
 use WE\SpreadsheetImport\Annotations\Mapping;
 use WE\SpreadsheetImport\Domain\Model\SpreadsheetImport;
 use WE\SpreadsheetImport\SpreadsheetImportService;
-use WE\SpreadsheetImport\Tests\Functional\Fixtures\ImportTarget;
+use WE\SpreadsheetImport\Tests\Functional\Fixtures\Domain\Model\ImportTarget;
+use WE\SpreadsheetImport\Tests\Functional\Fixtures\Domain\Model\ImportTargetCategory;
 
 class SpreadsheetImportServiceTest extends FunctionalTestCase {
 
@@ -41,19 +42,17 @@ class SpreadsheetImportServiceTest extends FunctionalTestCase {
 
 		$reflectionService = $this->objectManager->get(ReflectionService::class);
 		$this->inject($this->spreadsheetImportService, 'reflectionService', $reflectionService);
-
-		$this->initializeSpreadsheetMock();
 	}
 
 	/**
 	 * @return void
 	 */
 	public function tearDown() {
-		$persistenceManager = self::$bootstrap->getObjectManager()->get('TYPO3\Flow\Persistence\PersistenceManagerInterface');
+		$persistenceManager = $this->objectManager->get('TYPO3\Flow\Persistence\PersistenceManagerInterface');
 		if (is_callable(array($persistenceManager, 'tearDown'))) {
 			$persistenceManager->tearDown();
 		}
-		self::$bootstrap->getObjectManager()->forgetInstance('TYPO3\Flow\Persistence\PersistenceManagerInterface');
+		$this->objectManager->forgetInstance('TYPO3\Flow\Persistence\PersistenceManagerInterface');
 		parent::tearDown();
 	}
 
@@ -62,47 +61,75 @@ class SpreadsheetImportServiceTest extends FunctionalTestCase {
 		$spreadsheetImport->setContext('testing');
 		$resource = $this->resourceManager->importResource(__DIR__ . '/Fixtures/Resources/sample.xlsx');
 		$spreadsheetImport->setFile($resource);
-		$idMapping = array('column' => 'C', 'mapping' => new Mapping());
-		$nameMapping = array('column' => 'A', 'mapping' => new Mapping());
-		$spreadsheetImport->setMapping(array('id' => $idMapping, 'name' => $nameMapping));
 		$this->spreadsheetImportService->init($spreadsheetImport);
+
+		return $spreadsheetImport;
+	}
+
+	private function initializeConfiguredSpreadsheetMock() {
+		$spreadsheetImport = $this->initializeSpreadsheetMock();
+		$annotationMappings = $this->spreadsheetImportService->getAnnotationMappingProperties();
+		$spreadsheetImport->setMapping(array(
+			'id' => array('column' => 'C', 'mapping' => $annotationMappings['id']),
+			'firstName' => array('column' => 'A', 'mapping' => $annotationMappings['firstName']),
+			'lastName' => array('column' => 'B', 'mapping' => $annotationMappings['lastName']),
+			'account' => array('column' => 'C', 'mapping' => $annotationMappings['account'])));
+		$spreadsheetImport->setArguments(array(
+			'category' => new ImportTargetCategory(), // Could also simply assign the UUID
+			'comment' => 'Sample import'
+		));
 	}
 
 	/**
 	 * @test
 	 */
-	public function getMappingPropertiesReturnsPropertiesWithMappingAnnotation() {
+	public function getAnnotationMappingPropertiesReturnsArrayMappingAnnotation() {
+		$this->initializeSpreadsheetMock();
 		$properties = $this->spreadsheetImportService->getAnnotationMappingProperties();
 		$this->assertArrayHasKey('id', $properties);
-		$this->assertArrayHasKey('name', $properties);
+		$this->assertArrayHasKey('firstName', $properties);
 		/** @var Mapping $id */
 		$id = $properties['id'];
-		/** @var Mapping $name */
-		$name = $properties['name'];
+		/** @var Mapping $firstName */
+		$firstName = $properties['firstName'];
 		$this->assertSame(TRUE, $id->identifier);
-		$this->assertSame(FALSE, $name->identifier);
+		$this->assertSame(FALSE, $firstName->identifier);
+	}
+
+	/**
+	 * @test
+	 */
+	public function getTotalRecordsRecordsNumberOfObjectsToImport() {
+		$this->initializeSpreadsheetMock();
+		$this->assertSame(2, $this->spreadsheetImportService->getTotalRecords());
 	}
 
 	/**
 	 * @test
 	 */
 	public function getSpreadsheetColumnsReturnsColumnsWithHeadings() {
+		$this->initializeSpreadsheetMock();
 		$columns = $this->spreadsheetImportService->getSpreadsheetColumns();
 		$this->assertArrayHasKey('A', $columns);
 		$this->assertArrayHasKey('B', $columns);
 		$this->assertArrayHasKey('C', $columns);
-		$this->assertContains('name', $columns);
-		$this->assertContains('lastname', $columns);
-		$this->assertContains('id', $columns);
+		$this->assertSame('firstname', $columns['A']);
+		$this->assertSame('name', $columns['B']);
+		$this->assertSame('id', $columns['C']);
 	}
 
 	/**
 	 * @test
 	 */
 	public function getObjectByRowOneReturnsImportTargetWithSetProperties() {
+		$this->initializeConfiguredSpreadsheetMock();
 		/** @var ImportTarget $object */
 		$object = $this->spreadsheetImportService->getObjectByRow(1);
-		$this->assertEquals('00001', $object->getId());
-		$this->assertEquals('Hans', $object->getName());
+		$this->assertSame('00001', $object->getId());
+		$this->assertSame('Hans', $object->getFirstName());
+		$this->assertSame('Muster', $object->getLastName());
+		$this->assertSame('001', $object->getAccount());
+		$this->assertInstanceOf(ImportTargetCategory::class, $object->getCategory());
+		$this->assertSame('Sample import', $object->getComment());
 	}
 }