Merge pull request #219 from kdambekalns/code-tweaks

kdambekalns · web-flow · commit 0c9251998b13 · 2017-07-10T12:08:48.000+02:00
TASK: Some general (style) tweaks to code
diff --git a/.travis.yml b/.travis.yml
@@ -13,8 +13,8 @@ sudo: false
 before_install:
   - export NEOS_TARGET_VERSION=2.3
   - cd ..
-  - if [ "$ES" = 1 ]; then wget --no-check-certificate https://download.elastic.co/elasticsearch/elasticsearch/elasticsearch-1.7.5.zip && unzip elasticsearch-1.7.5.zip && mv elasticsearch-1.7.5 elasticsearch; fi
-  - if [ "$ES" = 2 ]; then wget --no-check-certificate https://download.elastic.co/elasticsearch/elasticsearch/elasticsearch-2.4.3.zip && unzip elasticsearch-2.4.3.zip && mv elasticsearch-2.4.3 elasticsearch; fi
+  - if [ "$ES" = 1 ]; then wget --no-check-certificate https://download.elastic.co/elasticsearch/elasticsearch/elasticsearch-1.7.6.zip && unzip elasticsearch-1.7.6.zip && mv elasticsearch-1.7.6 elasticsearch; fi
+  - if [ "$ES" = 2 ]; then wget --no-check-certificate https://download.elastic.co/elasticsearch/elasticsearch/elasticsearch-2.4.5.zip && unzip elasticsearch-2.4.5.zip && mv elasticsearch-2.4.5 elasticsearch; fi
   - cd elasticsearch
   - bin/elasticsearch -d
   - cd ..
diff --git a/Classes/Command/NodeIndexCommandController.php b/Classes/Command/NodeIndexCommandController.php
@@ -11,12 +11,22 @@
  * source code.
  */
 
+use Flowpack\ElasticSearch\ContentRepositoryAdaptor\LoggerInterface;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Mapping\NodeTypeMappingBuilder;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Service\IndexWorkspaceTrait;
+use Flowpack\ElasticSearch\Domain\Model\Mapping;
+use Flowpack\ElasticSearch\Transfer\Exception\ApiException;
+use Symfony\Component\Yaml\Yaml;
 use TYPO3\Flow\Annotations as Flow;
 use TYPO3\Flow\Cli\CommandController;
+use TYPO3\Flow\Configuration\ConfigurationManager;
+use TYPO3\Flow\Object\ObjectManagerInterface;
 use TYPO3\Neos\Controller\CreateContentContextTrait;
 use TYPO3\TYPO3CR\Domain\Model\Workspace;
+use TYPO3\TYPO3CR\Domain\Repository\NodeDataRepository;
+use TYPO3\TYPO3CR\Domain\Repository\WorkspaceRepository;
+use TYPO3\TYPO3CR\Domain\Service\ContentDimensionPresetSourceInterface;
+use TYPO3\TYPO3CR\Search\Indexer\NodeIndexerInterface;
 
 /**
  * Provides CLI features for index handling
@@ -30,19 +40,19 @@ class NodeIndexCommandController extends CommandController
 
     /**
      * @Flow\Inject
-     * @var \TYPO3\TYPO3CR\Search\Indexer\NodeIndexerInterface
+     * @var NodeIndexerInterface
      */
     protected $nodeIndexer;
 
     /**
      * @Flow\Inject
-     * @var \TYPO3\TYPO3CR\Domain\Repository\WorkspaceRepository
+     * @var WorkspaceRepository
      */
     protected $workspaceRepository;
 
     /**
      * @Flow\Inject
-     * @var \TYPO3\TYPO3CR\Domain\Repository\NodeDataRepository
+     * @var NodeDataRepository
      */
     protected $nodeDataRepository;
 
@@ -54,7 +64,7 @@ class NodeIndexCommandController extends CommandController
 
     /**
      * @Flow\Inject
-     * @var \TYPO3\TYPO3CR\Domain\Service\ContentDimensionPresetSourceInterface
+     * @var ContentDimensionPresetSourceInterface
      */
     protected $contentDimensionPresetSource;
 
@@ -66,13 +76,13 @@ class NodeIndexCommandController extends CommandController
 
     /**
      * @Flow\Inject
-     * @var \Flowpack\ElasticSearch\ContentRepositoryAdaptor\LoggerInterface
+     * @var LoggerInterface
      */
     protected $logger;
 
     /**
      * @Flow\Inject
-     * @var \TYPO3\Flow\Configuration\ConfigurationManager
+     * @var ConfigurationManager
      */
     protected $configurationManager;
 
@@ -88,8 +98,8 @@ class NodeIndexCommandController extends CommandController
      */
     public function initializeObject($cause)
     {
-        if ($cause === \TYPO3\Flow\Object\ObjectManagerInterface::INITIALIZATIONCAUSE_CREATED) {
-            $this->settings = $this->configurationManager->getConfiguration(\TYPO3\Flow\Configuration\ConfigurationManager::CONFIGURATION_TYPE_SETTINGS, 'TYPO3.TYPO3CR.Search');
+        if ($cause === ObjectManagerInterface::INITIALIZATIONCAUSE_CREATED) {
+            $this->settings = $this->configurationManager->getConfiguration(ConfigurationManager::CONFIGURATION_TYPE_SETTINGS, 'TYPO3.TYPO3CR.Search');
         }
     }
 
@@ -102,8 +112,8 @@ public function showMappingCommand()
     {
         $nodeTypeMappingCollection = $this->nodeTypeMappingBuilder->buildMappingInformation($this->nodeIndexer->getIndex());
         foreach ($nodeTypeMappingCollection as $mapping) {
-            /** @var \Flowpack\ElasticSearch\Domain\Model\Mapping $mapping */
-            $this->output(\Symfony\Component\Yaml\Yaml::dump($mapping->asArray(), 5, 2));
+            /** @var Mapping $mapping */
+            $this->output(Yaml::dump($mapping->asArray(), 5, 2));
             $this->outputLine();
         }
         $this->outputLine('------------');
@@ -181,6 +191,7 @@ public function indexNodeCommand($identifier, $workspace = null)
                 $indexInWorkspace($identifier, $workspace);
             }
         } else {
+            /** @var Workspace $workspaceInstance */
             $workspaceInstance = $this->workspaceRepository->findByIdentifier($workspace);
             if ($workspaceInstance === null) {
                 $this->outputLine('The given workspace (%s) does not exist.', [$workspace]);
@@ -198,7 +209,7 @@ public function indexNodeCommand($identifier, $workspace = null)
      * @param integer $limit Amount of nodes to index at maximum
      * @param boolean $update if TRUE, do not throw away the index at the start. Should *only be used for development*.
      * @param string $workspace name of the workspace which should be indexed
-     * @param string $postfix Index postfix, index with the same postifix will be deleted if exist
+     * @param string $postfix Index postfix, index with the same postfix will be deleted if exist
      * @return void
      */
     public function buildCommand($limit = null, $update = false, $workspace = null, $postfix = null)
@@ -211,21 +222,9 @@ public function buildCommand($limit = null, $update = false, $workspace = null,
         if ($update === true) {
             $this->logger->log('!!! Update Mode (Development) active!', LOG_INFO);
         } else {
-            $this->nodeIndexer->setIndexNamePostfix($postfix ?: time());
-            if ($this->nodeIndexer->getIndex()->exists() === true) {
-                $this->logger->log(sprintf('Deleted index with the same postfix (%s)!', $postfix), LOG_WARNING);
-                $this->nodeIndexer->getIndex()->delete();
-            }
-            $this->nodeIndexer->getIndex()->create();
-            $this->logger->log('Created index ' . $this->nodeIndexer->getIndexName(), LOG_INFO);
-
-            $nodeTypeMappingCollection = $this->nodeTypeMappingBuilder->buildMappingInformation($this->nodeIndexer->getIndex());
-            foreach ($nodeTypeMappingCollection as $mapping) {
-                /** @var \Flowpack\ElasticSearch\Domain\Model\Mapping $mapping */
-                $mapping->apply();
-            }
-            $this->logger->log('Updated Mapping.', LOG_INFO);
+            $this->createNewIndex($postfix);
         }
+        $this->applyMapping();
 
         $this->logger->log(sprintf('Indexing %snodes ... ', ($limit !== null ? 'the first ' . $limit . ' ' : '')), LOG_INFO);
 
@@ -277,9 +276,41 @@ public function cleanupCommand()
             } else {
                 $this->logger->log('Nothing to remove.');
             }
-        } catch (\Flowpack\ElasticSearch\Transfer\Exception\ApiException $exception) {
+        } catch (ApiException $exception) {
             $response = json_decode($exception->getResponse());
             $this->logger->log(sprintf('Nothing removed. ElasticSearch responded with status %s, saying "%s: %s"', $response->status, $response->error->type, $response->error->reason));
         }
     }
+
+    /**
+     * Create a new index with the given $postfix.
+     *
+     * @param string $postfix
+     * @return void
+     */
+    protected function createNewIndex($postfix)
+    {
+        $this->nodeIndexer->setIndexNamePostfix($postfix ?: time());
+        if ($this->nodeIndexer->getIndex()->exists() === true) {
+            $this->logger->log(sprintf('Deleted index with the same postfix (%s)!', $postfix), LOG_WARNING);
+            $this->nodeIndexer->getIndex()->delete();
+        }
+        $this->nodeIndexer->getIndex()->create();
+        $this->logger->log('Created index ' . $this->nodeIndexer->getIndexName(), LOG_INFO);
+    }
+
+    /**
+     * Apply the mapping to the current index.
+     *
+     * @return void
+     */
+    protected function applyMapping()
+    {
+        $nodeTypeMappingCollection = $this->nodeTypeMappingBuilder->buildMappingInformation($this->nodeIndexer->getIndex());
+        foreach ($nodeTypeMappingCollection as $mapping) {
+            /** @var Mapping $mapping */
+            $mapping->apply();
+        }
+        $this->logger->log('Updated Mapping.', LOG_INFO);
+    }
 }
diff --git a/Classes/Driver/Version1/DocumentDriver.php b/Classes/Driver/Version1/DocumentDriver.php
@@ -13,7 +13,6 @@
 
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\AbstractDriver;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\DocumentDriverInterface;
-use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\DriverInterface;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Mapping\NodeTypeMappingBuilder;
 use Flowpack\ElasticSearch\Domain\Model\Index;
 use TYPO3\Flow\Annotations as Flow;
diff --git a/Classes/Driver/Version1/IndexDriver.php b/Classes/Driver/Version1/IndexDriver.php
@@ -12,7 +12,6 @@
  */
 
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\AbstractDriver;
-use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\DriverInterface;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\IndexDriverInterface;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception;
 use TYPO3\Flow\Annotations as Flow;
diff --git a/Classes/Driver/Version1/IndexerDriver.php b/Classes/Driver/Version1/IndexerDriver.php
@@ -12,7 +12,6 @@
  */
 
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\AbstractIndexerDriver;
-use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\DriverInterface;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\IndexerDriverInterface;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Mapping\NodeTypeMappingBuilder;
 use Flowpack\ElasticSearch\Domain\Model\Document as ElasticSearchDocument;
diff --git a/Classes/Factory/AbstractDriverSpecificObjectFactory.php b/Classes/Factory/AbstractDriverSpecificObjectFactory.php
@@ -11,7 +11,6 @@
  * source code.
  */
 
-use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\DriverInterface;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Exception\DriverConfigurationException;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\LoggerInterface;
 use TYPO3\Flow\Annotations as Flow;
diff --git a/Classes/Factory/DriverFactory.php b/Classes/Factory/DriverFactory.php
@@ -12,7 +12,6 @@
  */
 
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\DocumentDriverInterface;
-use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\DriverInterface;
 use Flowpack\ElasticSearch\ContentRepositoryAdaptor\Driver\IndexerDriverInterface;
 use TYPO3\Flow\Annotations as Flow;
 
