Merge pull request #289 from magento-tango/MAGETWO-37436

[Tango] S52 Controller Refactoring, Bug Fixes

Author: Kovsher, Iurii(ikovsher)

app/code/Magento/Developer/Model/View/Layout/Plugin.php

@@ -10,9 +10,6 @@
     <type name="Magento\Framework\View\TemplateEngineFactory">
         <plugin name="debug_hints" type="Magento\Developer\Model\TemplateEngine\Plugin\DebugHints" sortOrder="10"/>
     </type>
-    <type name="Magento\Framework\View\Layout">
-        <plugin name="exception_handler" type="Magento\Developer\Model\View\Layout\Plugin" sortOrder="10"/>
-    </type>
     <type name="Magento\Framework\View\Result\Page">
         <arguments>
             <argument name="pageConfigRendererFactory" xsi:type="object">Magento\Developer\Model\View\Page\Config\RendererFactory</argument>

app/code/Magento/Developer/etc/di.xml

@@ -1,12 +1,18 @@
 <?php
 /**
- *
  * Copyright © 2015 Magento. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Magento\GroupedProduct\Controller\Adminhtml\Edit;
 
-class Popup extends \Magento\Backend\App\AbstractAction
+use Magento\Backend\App\AbstractAction;
+use Magento\Backend\App\Action\Context;
+use Magento\Framework\Registry;
+use Magento\Catalog\Model\ProductFactory;
+use Psr\Log\LoggerInterface;
+use Magento\Framework\Controller\ResultFactory;
+
+class Popup extends AbstractAction
 {
     /**
      * @var \Magento\Framework\Registry
@@ -30,10 +36,10 @@ class Popup extends \Magento\Backend\App\AbstractAction
      * @param \Psr\Log\LoggerInterface $logger
      */
     public function __construct(
-        \Magento\Backend\App\Action\Context $context,
-        \Magento\Framework\Registry $registry,
-        \Magento\Catalog\Model\ProductFactory $factory,
-        \Psr\Log\LoggerInterface $logger
+        Context $context,
+        Registry $registry,
+        ProductFactory $factory,
+        LoggerInterface $logger
     ) {
         $this->registry = $registry;
         $this->factory = $factory;
@@ -54,7 +60,7 @@ protected function _isAllowed()
     /**
      * Get associated grouped products grid popup
      *
-     * @return void
+     * @return \Magento\Framework\View\Result\Layout
      */
     public function execute()
     {
@@ -84,8 +90,8 @@ public function execute()
             $product->setAttributeSetId($setId);
         }
         $this->registry->register('current_product', $product);
-
-        $this->_view->loadLayout(false);
-        $this->_view->renderLayout();
+        /** @var \Magento\Framework\View\Result\Layout $resultLayout */
+        $resultLayout = $this->resultFactory->create(ResultFactory::TYPE_LAYOUT);
+        return $resultLayout;
     }
 }

app/code/Magento/GroupedProduct/Controller/Adminhtml/Edit/Popup.php

@@ -5,6 +5,8 @@
  */
 namespace Magento\GroupedProduct\Test\Unit\Controller\Adminhtml\Edit;
 
+use Magento\Framework\Controller\ResultFactory;
+
 class PopupTest extends \PHPUnit_Framework_TestCase
 {
     /**
@@ -17,6 +19,11 @@ class PopupTest extends \PHPUnit_Framework_TestCase
      */
     protected $action;
 
+    /**
+     * @var \Magento\Backend\App\Action\Context
+     */
+    protected $context;
+
     /**
      * @var \PHPUnit_Framework_MockObject_MockObject
      */
@@ -33,25 +40,46 @@ class PopupTest extends \PHPUnit_Framework_TestCase
     protected $registry;
 
     /**
-     * @var \PHPUnit_Framework_MockObject_MockObject
+     * @var \Magento\Framework\Controller\ResultFactory|\PHPUnit_Framework_MockObject_MockObject
+     */
+    protected $resultFactoryMock;
+
+    /**
+     * @var \Magento\Framework\View\Result\Layout|\PHPUnit_Framework_MockObject_MockObject
      */
-    protected $view;
+    protected $resultLayoutMock;
 
     protected function setUp()
     {
         $this->request = $this->getMock('Magento\Framework\App\RequestInterface', [], [], '', false);
         $this->factory = $this->getMock('Magento\Catalog\Model\ProductFactory', ['create'], [], '', false);
         $this->registry = $this->getMock('Magento\Framework\Registry', [], [], '', false);
-        $this->view = $this->getMock('Magento\Framework\App\ViewInterface', [], [], '', false);
+        $this->resultFactoryMock = $this->getMockBuilder('Magento\Framework\Controller\ResultFactory')
+            ->disableOriginalConstructor()
+            ->getMock();
+        $this->resultLayoutMock = $this->getMockBuilder('Magento\Framework\View\Result\Layout')
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $this->resultFactoryMock->expects($this->any())
+            ->method('create')
+            ->with(ResultFactory::TYPE_LAYOUT, [])
+            ->willReturn($this->resultLayoutMock);
 
         $this->objectManager = new \Magento\Framework\TestFramework\Unit\Helper\ObjectManager($this);
+        $this->context = $this->objectManager->getObject(
+            'Magento\Backend\App\Action\Context',
+            [
+                'request' => $this->request,
+                'resultFactory' => $this->resultFactoryMock
+            ]
+        );
         $this->action = $this->objectManager->getObject(
             'Magento\GroupedProduct\Controller\Adminhtml\Edit\Popup',
             [
-                'request' => $this->request,
+                'context' => $this->context,
                 'factory' => $this->factory,
-                'registry' => $this->registry,
-                'view' => $this->view
+                'registry' => $this->registry
             ]
         );
     }
@@ -90,10 +118,7 @@ public function testPopupActionNoProductId()
         $this->request->expects($this->at(3))->method('getParam')->with('set')->will($this->returnValue($setId));
         $this->registry->expects($this->once())->method('register')->with('current_product', $product);
 
-        $this->view->expects($this->once())->method('loadLayout')->with(false);
-        $this->view->expects($this->once())->method('renderLayout');
-
-        $this->action->execute();
+        $this->assertSame($this->resultLayoutMock, $this->action->execute());
     }
 
     public function testPopupActionWithProductIdNoSetId()
@@ -130,9 +155,6 @@ public function testPopupActionWithProductIdNoSetId()
         $this->request->expects($this->at(3))->method('getParam')->with('set')->will($this->returnValue($setId));
         $this->registry->expects($this->once())->method('register')->with('current_product', $product);
 
-        $this->view->expects($this->once())->method('loadLayout')->with(false);
-        $this->view->expects($this->once())->method('renderLayout');
-
-        $this->action->execute();
+        $this->assertSame($this->resultLayoutMock, $this->action->execute());
     }
 }

app/code/Magento/GroupedProduct/Test/Unit/Controller/Adminhtml/Edit/PopupTest.php

@@ -3,15 +3,14 @@
  * Copyright © 2015 Magento. All rights reserved.
  * See COPYING.txt for license details.
  */
+namespace Magento\ImportExport\Controller\Adminhtml;
+
+use Magento\Backend\App\Action;
 
 /**
  * Export controller
- *
- * @author      Magento Core Team <core@magentocommerce.com>
  */
-namespace Magento\ImportExport\Controller\Adminhtml;
-
-class Export extends \Magento\Backend\App\Action
+class Export extends Action
 {
     /**
      * Check access (in the ACL) for current user

app/code/Magento/ImportExport/Controller/Adminhtml/Export.php

@@ -1,52 +1,57 @@
 <?php
 /**
- *
  * Copyright © 2015 Magento. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Magento\ImportExport\Controller\Adminhtml\Export;
 
+use Magento\Framework\Controller\ResultFactory;
+use Magento\ImportExport\Controller\Adminhtml\Export as ExportController;
+use Magento\Backend\App\Action\Context;
+use Magento\Framework\App\Response\Http\FileFactory;
+use Magento\ImportExport\Model\Export as ExportModel;
 use Magento\Framework\App\Filesystem\DirectoryList;
+use Magento\Framework\Exception\LocalizedException;
 
-class Export extends \Magento\ImportExport\Controller\Adminhtml\Export
+class Export extends ExportController
 {
     /**
      * @var \Magento\Framework\App\Response\Http\FileFactory
      */
-    protected $_fileFactory;
+    protected $fileFactory;
 
     /**
      * @param \Magento\Backend\App\Action\Context $context
      * @param \Magento\Framework\App\Response\Http\FileFactory $fileFactory
      */
     public function __construct(
-        \Magento\Backend\App\Action\Context $context,
-        \Magento\Framework\App\Response\Http\FileFactory $fileFactory
+        Context $context,
+        FileFactory $fileFactory
     ) {
-        $this->_fileFactory = $fileFactory;
+        $this->fileFactory = $fileFactory;
         parent::__construct($context);
     }
 
     /**
      * Load data with filter applying and create file for download.
      *
-     * @return $this
+     * @return \Magento\Backend\Model\View\Result\Redirect
      */
     public function execute()
     {
-        if ($this->getRequest()->getPost(\Magento\ImportExport\Model\Export::FILTER_ELEMENT_GROUP)) {
+        if ($this->getRequest()->getPost(ExportModel::FILTER_ELEMENT_GROUP)) {
             try {
                 /** @var $model \Magento\ImportExport\Model\Export */
                 $model = $this->_objectManager->create('Magento\ImportExport\Model\Export');
                 $model->setData($this->getRequest()->getParams());
 
-                return $this->_fileFactory->create(
+                return $this->fileFactory->create(
                     $model->getFileName(),
                     $model->export(),
                     DirectoryList::VAR_DIR,
                     $model->getContentType()
                 );
-            } catch (\Magento\Framework\Exception\LocalizedException $e) {
+            } catch (LocalizedException $e) {
                 $this->messageManager->addError($e->getMessage());
             } catch (\Exception $e) {
                 $this->_objectManager->get('Psr\Log\LoggerInterface')->critical($e);
@@ -55,6 +60,9 @@ public function execute()
         } else {
             $this->messageManager->addError(__('Please correct the data sent.'));
         }
-        return $this->_redirect('adminhtml/*/index');
+        /** @var \Magento\Backend\Model\View\Result\Redirect $resultRedirect */
+        $resultRedirect = $this->resultFactory->create(ResultFactory::TYPE_REDIRECT);
+        $resultRedirect->setPath('adminhtml/*/index');
+        return $resultRedirect;
     }
 }

app/code/Magento/ImportExport/Controller/Adminhtml/Export/Export.php

@@ -1,42 +1,46 @@
 <?php
 /**
- *
  * Copyright © 2015 Magento. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Magento\ImportExport\Controller\Adminhtml\Export;
 
-class GetFilter extends \Magento\ImportExport\Controller\Adminhtml\Export
+use Magento\ImportExport\Controller\Adminhtml\Export as ExportController;
+use Magento\Framework\Controller\ResultFactory;
+
+class GetFilter extends ExportController
 {
     /**
      * Get grid-filter of entity attributes action.
      *
-     * @return void
+     * @return \Magento\Framework\Controller\ResultInterface
      */
     public function execute()
     {
         $data = $this->getRequest()->getParams();
         if ($this->getRequest()->isXmlHttpRequest() && $data) {
             try {
-                $this->_view->loadLayout();
-
+                /** @var \Magento\Framework\View\Result\Layout $resultLayout */
+                $resultLayout = $this->resultFactory->create(ResultFactory::TYPE_LAYOUT);
                 /** @var $attrFilterBlock \Magento\ImportExport\Block\Adminhtml\Export\Filter */
-                $attrFilterBlock = $this->_view->getLayout()->getBlock('export.filter');
+                $attrFilterBlock = $resultLayout->getLayout()->getBlock('export.filter');
                 /** @var $export \Magento\ImportExport\Model\Export */
                 $export = $this->_objectManager->create('Magento\ImportExport\Model\Export');
                 $export->setData($data);
 
                 $export->filterAttributeCollection(
                     $attrFilterBlock->prepareCollection($export->getEntityAttributeCollection())
                 );
-                $this->_view->renderLayout();
-                return;
+                return $resultLayout;
             } catch (\Exception $e) {
                 $this->messageManager->addError($e->getMessage());
             }
         } else {
             $this->messageManager->addError(__('Please correct the data sent.'));
         }
-        $this->_redirect('adminhtml/*/index');
+        /** @var \Magento\Backend\Model\View\Result\Redirect $resultRedirect */
+        $resultRedirect = $this->resultFactory->create(ResultFactory::TYPE_REDIRECT);
+        $resultRedirect->setPath('adminhtml/*/index');
+        return $resultRedirect;
     }
 }