ENGCOM-7954: Apply review suggestion to the media modules #29396

magento-engcom-team · magento-engcom-team · commit 4e891cc442f8 · 2020-08-05T10:16:34.000-05:00
- Merge Pull Request #29396 from sivaschenko/magento2:media-review-suggestions - Merged commits: 1. 1a7149b
diff --git a/app/code/Magento/MediaContentSynchronizationApi/Api/SynchronizerInterface.php b/app/code/Magento/MediaContentSynchronizationApi/Api/SynchronizerInterface.php
diff --git a/app/code/Magento/MediaContentSynchronizationApi/Model/SynchronizerPool.php b/app/code/Magento/MediaContentSynchronizationApi/Model/SynchronizerPool.php
@@ -7,7 +7,7 @@
 
 namespace Magento\MediaContentSynchronizationApi\Model;
 
-use Magento\MediaContentSynchronizationApi\Api\SynchronizerInterface;
+use Magento\MediaContentSynchronizationApi\Api\SynchronizeInterface;
 
 /**
  * A pool that handles content and assets synchronization.
@@ -18,20 +18,20 @@ class SynchronizerPool
     /**
      * Content with assets synchronizers
      *
-     * @var SynchronizerInterface[]
+     * @var SynchronizeInterface[]
      */
     private $synchronizers;
 
     /**
-     * @param SynchronizerInterface[] $synchronizers
+     * @param SynchronizeInterface[] $synchronizers
      */
     public function __construct(
         array $synchronizers = []
     ) {
         foreach ($synchronizers as $synchronizer) {
-            if (!$synchronizer instanceof SynchronizerInterface) {
+            if (!$synchronizer instanceof SynchronizeInterface) {
                 throw new \InvalidArgumentException(
-                    get_class($synchronizer) . ' must implement ' . SynchronizerInterface::class
+                    get_class($synchronizer) . ' must implement ' . SynchronizeInterface::class
                 );
             }
         }
@@ -42,7 +42,7 @@ public function __construct(
     /**
      * Get all synchronizers from the pool
      *
-     * @return SynchronizerInterface[]
+     * @return SynchronizeInterface[]
      */
     public function get(): array
     {
diff --git a/app/code/Magento/MediaContentSynchronizationCatalog/Model/Synchronizer/Category.php b/app/code/Magento/MediaContentSynchronizationCatalog/Model/Synchronizer/Category.php
@@ -10,13 +10,13 @@
 use Magento\MediaContentApi\Api\Data\ContentIdentityInterfaceFactory;
 use Magento\MediaContentApi\Api\UpdateContentAssetLinksInterface;
 use Magento\MediaContentApi\Model\GetEntityContentsInterface;
-use Magento\MediaContentSynchronizationApi\Api\SynchronizerInterface;
+use Magento\MediaContentSynchronizationApi\Api\SynchronizeInterface;
 use Magento\MediaGallerySynchronizationApi\Model\FetchBatchesInterface;
 
 /**
  * Synchronize category content with assets
  */
-class Category implements SynchronizerInterface
+class Category implements SynchronizeInterface
 {
     private const CONTENT_TYPE = 'catalog_category';
     private const TYPE = 'entityType';
diff --git a/app/code/Magento/MediaContentSynchronizationCatalog/Model/Synchronizer/Product.php b/app/code/Magento/MediaContentSynchronizationCatalog/Model/Synchronizer/Product.php
@@ -10,13 +10,13 @@
 use Magento\MediaContentApi\Api\Data\ContentIdentityInterfaceFactory;
 use Magento\MediaContentApi\Api\UpdateContentAssetLinksInterface;
 use Magento\MediaContentApi\Model\GetEntityContentsInterface;
-use Magento\MediaContentSynchronizationApi\Api\SynchronizerInterface;
+use Magento\MediaContentSynchronizationApi\Api\SynchronizeInterface;
 use Magento\MediaGallerySynchronizationApi\Model\FetchBatchesInterface;
 
 /**
  * Synchronize product content with assets
  */
-class Product implements SynchronizerInterface
+class Product implements SynchronizeInterface
 {
     private const CONTENT_TYPE = 'catalog_product';
     private const TYPE = 'entityType';
diff --git a/app/code/Magento/MediaContentSynchronizationCms/Model/Synchronizer/Block.php b/app/code/Magento/MediaContentSynchronizationCms/Model/Synchronizer/Block.php
@@ -9,13 +9,13 @@
 
 use Magento\MediaContentApi\Api\Data\ContentIdentityInterfaceFactory;
 use Magento\MediaContentApi\Api\UpdateContentAssetLinksInterface;
-use Magento\MediaContentSynchronizationApi\Api\SynchronizerInterface;
+use Magento\MediaContentSynchronizationApi\Api\SynchronizeInterface;
 use Magento\MediaGallerySynchronizationApi\Model\FetchBatchesInterface;
 
 /**
  * Synchronize block content with assets
  */
-class Block implements SynchronizerInterface
+class Block implements SynchronizeInterface
 {
     private const CONTENT_TYPE = 'cms_block';
     private const TYPE = 'entityType';
diff --git a/app/code/Magento/MediaContentSynchronizationCms/Model/Synchronizer/Page.php b/app/code/Magento/MediaContentSynchronizationCms/Model/Synchronizer/Page.php
@@ -9,13 +9,13 @@
 
 use Magento\MediaContentApi\Api\Data\ContentIdentityInterfaceFactory;
 use Magento\MediaContentApi\Api\UpdateContentAssetLinksInterface;
-use Magento\MediaContentSynchronizationApi\Api\SynchronizerInterface;
+use Magento\MediaContentSynchronizationApi\Api\SynchronizeInterface;
 use Magento\MediaGallerySynchronizationApi\Model\FetchBatchesInterface;
 
 /**
  * Synchronize page content with assets
  */
-class Page implements SynchronizerInterface
+class Page implements SynchronizeInterface
 {
     private const CONTENT_TYPE = 'cms_page';
     private const TYPE = 'entityType';
diff --git a/app/code/Magento/MediaGalleryMetadata/Model/File/ExtractMetadata.php b/app/code/Magento/MediaGalleryMetadata/Model/File/ExtractMetadata.php
@@ -66,31 +66,12 @@ public function __construct(
     public function execute(string $path): MetadataInterface
     {
         try {
-            return $this->extractMetadata($path);
+            return $this->readSegments($this->fileReader->execute($path));
         } catch (\Exception $exception) {
             return $this->metadataFactory->create();
         }
     }
 
-    /**
-     * Extract metadata from file
-     *
-     * @param string $path
-     * @return MetadataInterface
-     */
-    private function extractMetadata(string $path): MetadataInterface
-    {
-        try {
-            $file = $this->fileReader->execute($path);
-        } catch (\Exception $exception) {
-            throw new LocalizedException(
-                __('Could not parse the image file for metadata: %path', ['path' => $path])
-            );
-        }
-
-        return $this->readSegments($file);
-    }
-
     /**
      * Read  file segments by given segmentReader
      *
diff --git a/app/code/Magento/MediaGallerySynchronization/Model/CreateAssetFromFile.php b/app/code/Magento/MediaGallerySynchronization/Model/CreateAssetFromFile.php
@@ -17,7 +17,7 @@
 use Magento\MediaGalleryApi\Api\Data\AssetInterfaceFactory;
 use Magento\MediaGalleryMetadataApi\Api\ExtractMetadataInterface;
 use Magento\MediaGallerySynchronization\Model\Filesystem\SplFileInfoFactory;
-use Magento\MediaGallerySynchronizationApi\Model\GetContentHashInterface;
+use Magento\MediaGallerySynchronization\Model\GetContentHash;
 
 /**
  * Create media asset object based on the file information
@@ -50,7 +50,7 @@ class CreateAssetFromFile
     private $assetFactory;
 
     /**
-     * @var GetContentHashInterface
+     * @var GetContentHash
      */
     private $getContentHash;
 
@@ -69,7 +69,7 @@ class CreateAssetFromFile
      * @param File $driver
      * @param TimezoneInterface $date
      * @param AssetInterfaceFactory $assetFactory
-     * @param GetContentHashInterface $getContentHash
+     * @param GetContentHash $getContentHash
      * @param ExtractMetadataInterface $extractMetadata
      * @param SplFileInfoFactory $splFileInfoFactory
      */
@@ -78,7 +78,7 @@ public function __construct(
         File $driver,
         TimezoneInterface $date,
         AssetInterfaceFactory $assetFactory,
-        GetContentHashInterface $getContentHash,
+        GetContentHash $getContentHash,
         ExtractMetadataInterface $extractMetadata,
         SplFileInfoFactory $splFileInfoFactory
     ) {
diff --git a/app/code/Magento/MediaGallerySynchronization/Model/GetContentHash.php b/app/code/Magento/MediaGallerySynchronization/Model/GetContentHash.php
@@ -7,12 +7,10 @@
 
 namespace Magento\MediaGallerySynchronization\Model;
 
-use Magento\MediaGallerySynchronizationApi\Model\GetContentHashInterface;
-
 /**
  * Get hashed value of image content.
  */
-class GetContentHash implements GetContentHashInterface
+class GetContentHash
 {
     /**
      * Return the hash value of the given filepath.
diff --git a/app/code/Magento/MediaGallerySynchronization/Test/Integration/Model/GetContentHashTest.php b/app/code/Magento/MediaGallerySynchronization/Test/Integration/Model/GetContentHashTest.php
@@ -9,17 +9,17 @@
 
 use Magento\Framework\Exception\FileSystemException;
 use Magento\Framework\Filesystem\DriverInterface;
-use Magento\MediaGallerySynchronizationApi\Model\GetContentHashInterface;
+use Magento\MediaGallerySynchronization\Model\GetContentHash;
 use Magento\TestFramework\Helper\Bootstrap;
 use PHPUnit\Framework\TestCase;
 
 /**
- * Test for GetContentHashInterface.
+ * Test for GetContentHash.
  */
 class GetContentHashTest extends TestCase
 {
     /**
-     * @var GetContentHashInterface
+     * @var GetContentHash
      */
     private $getContentHash;
 
@@ -33,12 +33,12 @@ class GetContentHashTest extends TestCase
      */
     protected function setUp(): void
     {
-        $this->getContentHash = Bootstrap::getObjectManager()->get(GetContentHashInterface::class);
+        $this->getContentHash = Bootstrap::getObjectManager()->get(GetContentHash::class);
         $this->driver = Bootstrap::getObjectManager()->get(DriverInterface::class);
     }
 
     /**
-     * Test for GetContentHashInterface::execute
+     * Test for GetContentHash::execute
      *
      * @dataProvider filesProvider
      * @param string $firstFile
diff --git a/app/code/Magento/MediaGallerySynchronization/etc/di.xml b/app/code/Magento/MediaGallerySynchronization/etc/di.xml
@@ -9,7 +9,6 @@
     <preference for="Magento\MediaGallerySynchronizationApi\Api\SynchronizeInterface" type="Magento\MediaGallerySynchronization\Model\Synchronize"/>
     <preference for="Magento\MediaGallerySynchronizationApi\Model\FetchBatchesInterface" type="Magento\MediaGallerySynchronization\Model\FetchBatches"/>
     <preference for="Magento\MediaGallerySynchronizationApi\Api\SynchronizeFilesInterface" type="Magento\MediaGallerySynchronization\Model\SynchronizeFiles"/>
-    <preference for="Magento\MediaGallerySynchronizationApi\Model\GetContentHashInterface" type="Magento\MediaGallerySynchronization\Model\GetContentHash"/>
     <type name="Magento\MediaGallerySynchronizationApi\Model\ImportFilesComposite">
         <arguments>
             <argument name="importers" xsi:type="array">
diff --git a/app/code/Magento/MediaGallerySynchronizationApi/Model/GetContentHashInterface.php b/app/code/Magento/MediaGallerySynchronizationApi/Model/GetContentHashInterface.php
diff --git a/app/code/Magento/MediaGalleryUi/Ui/Component/Listing/Filters/Options/UsedIn.php b/app/code/Magento/MediaGalleryUi/Ui/Component/Listing/Filters/Options/UsedIn.php
@@ -14,24 +14,32 @@
  */
 class UsedIn implements OptionSourceInterface
 {
-    /**
-     * @var array
-     */
-    private $options;
-
-    /**
-     * @param array $options
-     */
-    public function __construct(array $options = [])
-    {
-        $this->options = $options;
-    }
-
     /**
      * @inheritdoc
      */
     public function toOptionArray(): array
     {
-        return $this->options;
+        return [
+            'cms_page' => [
+                'value' => 'cms_page',
+                'label' => 'Pages'
+            ],
+            'catalog_category' => [
+                'value' => 'catalog_category',
+                'label' => 'Categories'
+            ],
+            'cms_block' => [
+                'value' => 'cms_block',
+                'label' => 'Blocks'
+            ],
+            'catalog_product' => [
+                'value' => 'catalog_product',
+                'label' => 'Products'
+            ],
+            'not_used' => [
+                'value' => 'not_used',
+                'label' => 'Not used anywhere'
+            ]
+        ];
     }
 }
diff --git a/app/code/Magento/MediaGalleryUi/etc/adminhtml/di.xml b/app/code/Magento/MediaGalleryUi/etc/adminhtml/di.xml
@@ -41,30 +41,4 @@
             <argument name="collectionProcessor" xsi:type="object">Magento\MediaGalleryUi\Model\Api\SearchCriteria\CollectionProcessor</argument>
         </arguments>
     </type>
-    <type name="Magento\MediaGalleryUi\Ui\Component\Listing\Filters\Options\UsedIn">
-        <arguments>
-            <argument name="options" xsi:type="array">
-                <item name="cms_page" xsi:type="array">
-                    <item name="value" xsi:type="string">cms_page</item>
-                    <item name="label" xsi:type="string" translate="true">Pages</item>
-                </item>
-                <item name="catalog_category" xsi:type="array">
-                    <item name="value" xsi:type="string">catalog_category</item>
-                    <item name="label" xsi:type="string" translate="true">Categories</item>
-                </item>
-                <item name="cms_block" xsi:type="array">
-                    <item name="value" xsi:type="string">cms_block</item>
-                    <item name="label" xsi:type="string" translate="true">Blocks</item>
-                </item>
-                <item name="catalog_product" xsi:type="array">
-                    <item name="value" xsi:type="string">catalog_product</item>
-                    <item name="label" xsi:type="string" translate="true">Products</item>
-                </item>
-                <item name="not_used" xsi:type="array">
-                    <item name="value" xsi:type="string">not_used</item>
-                    <item name="label" xsi:type="string" translate="true">Not used anywhere</item>
-                </item>
-            </argument>
-        </arguments>
-    </type>
 </config>
