Skip to content

Cleanup ObjectManager usage - Magento_Analytics #27082

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -3,50 +3,55 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\Analytics\Block\Adminhtml\System\Config;

use Magento\Framework\App\ObjectManager;
use Magento\Backend\Block\Template\Context;
use Magento\Config\Block\System\Config\Form\Field;
use Magento\Framework\Data\Form\Element\AbstractElement;
use Magento\Framework\Locale\ResolverInterface;

/**
* Provides label with default Time Zone
*/
class CollectionTimeLabel extends \Magento\Config\Block\System\Config\Form\Field
class CollectionTimeLabel extends Field
{
/**
* @var \Magento\Framework\Locale\ResolverInterface
* @var ResolverInterface
*/
private $localeResolver;

/**
* @param \Magento\Backend\Block\Template\Context $context
* @param Context $context
* @param ResolverInterface $localeResolver
* @param array $data
* @param \Magento\Framework\Locale\ResolverInterface|null $localeResolver
*/
public function __construct(
\Magento\Backend\Block\Template\Context $context,
array $data = [],
\Magento\Framework\Locale\ResolverInterface $localeResolver = null
Context $context,
ResolverInterface $localeResolver,
array $data = []
) {
$this->localeResolver = $localeResolver ?:
ObjectManager::getInstance()->get(\Magento\Framework\Locale\ResolverInterface::class);
parent::__construct($context, $data);
$this->localeResolver = $localeResolver;
}

/**
* Add current time zone to comment, properly translated according to locale
*
* @param \Magento\Framework\Data\Form\Element\AbstractElement $element
* @param AbstractElement $element
*
* @return string
*/
public function render(\Magento\Framework\Data\Form\Element\AbstractElement $element)
public function render(AbstractElement $element): string
{
$timeZoneCode = $this->_localeDate->getConfigTimezone();
$locale = $this->localeResolver->getLocale();
$getLongTimeZoneName = \IntlTimeZone::createTimeZone($timeZoneCode)
->getDisplayName(false, \IntlTimeZone::DISPLAY_LONG, $locale);
$element->setData(
'comment',
sprintf("%s (%s)", $getLongTimeZoneName, $timeZoneCode)
sprintf('%s (%s)', $getLongTimeZoneName, $timeZoneCode)
);
return parent::render($element);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,43 +3,59 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\Analytics\Test\Unit\Block\Adminhtml\System\Config;

use Magento\Analytics\Block\Adminhtml\System\Config\CollectionTimeLabel;
use Magento\Backend\Block\Template\Context;
use Magento\Framework\Data\Form;
use Magento\Framework\Data\Form\Element\AbstractElement;
use Magento\Framework\Escaper;
use Magento\Framework\Locale\ResolverInterface;
use Magento\Framework\Stdlib\DateTime\TimezoneInterface;
use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;

class CollectionTimeLabelTest extends \PHPUnit\Framework\TestCase
/**
* Test class for \Magento\Analytics\Block\Adminhtml\System\Config\CollectionTimeLabel
*/
class CollectionTimeLabelTest extends TestCase
{
/**
* @var CollectionTimeLabel
*/
private $collectionTimeLabel;

/**
* @var Context|\PHPUnit_Framework_MockObject_MockObject
* @var Context|MockObject
*/
private $contextMock;

/**
* @var TimezoneInterface|\PHPUnit_Framework_MockObject_MockObject
* @var ResolverInterface|MockObject
*/
private $localeResolverMock;

/**
* @var Form|MockObject
*/
private $formMock;

/**
* @var TimezoneInterface|MockObject
*/
private $timeZoneMock;

/**
* @var AbstractElement|\PHPUnit_Framework_MockObject_MockObject
* @var AbstractElement|MockObject
*/
private $abstractElementMock;

/**
* @var ResolverInterface|\PHPUnit_Framework_MockObject_MockObject
* @inheritDoc
*/
private $localeResolver;

protected function setUp()
{
$this->abstractElementMock = $this->getMockBuilder(AbstractElement::class)
Expand All @@ -48,7 +64,7 @@ protected function setUp()
->getMock();

$objectManager = new ObjectManager($this);
$escaper = $objectManager->getObject(\Magento\Framework\Escaper::class);
$escaper = $objectManager->getObject(Escaper::class);
$reflection = new \ReflectionClass($this->abstractElementMock);
$reflection_property = $reflection->getProperty('_escaper');
$reflection_property->setAccessible(true);
Expand All @@ -64,35 +80,35 @@ protected function setUp()
$this->timeZoneMock = $this->getMockBuilder(TimezoneInterface::class)
->disableOriginalConstructor()
->getMock();
$this->contextMock->expects($this->any())
->method('getLocaleDate')
$this->contextMock->method('getLocaleDate')
->willReturn($this->timeZoneMock);
$this->localeResolver = $this->getMockBuilder(ResolverInterface::class)
$this->localeResolverMock = $this->getMockBuilder(ResolverInterface::class)
->disableOriginalConstructor()
->setMethods(['getLocale'])
->getMockForAbstractClass();

$objectManager = new ObjectManager($this);
$this->collectionTimeLabel = $objectManager->getObject(
CollectionTimeLabel::class,
[
'context' => $this->contextMock,
'localeResolver' => $this->localeResolver
'localeResolver' => $this->localeResolverMock
]
);
}

/**
* Test for \Magento\Analytics\Block\Adminhtml\System\Config\CollectionTimeLabel::render()
*/
public function testRender()
{
$timeZone = "America/New_York";
$timeZone = 'America/New_York';
$this->abstractElementMock->setForm($this->formMock);
$this->timeZoneMock->expects($this->once())
->method('getConfigTimezone')
->willReturn($timeZone);
$this->abstractElementMock->expects($this->any())
->method('getComment')
$this->abstractElementMock->method('getComment')
->willReturn('Eastern Standard Time (America/New_York)');
$this->localeResolver->expects($this->once())
$this->localeResolverMock->expects($this->once())
->method('getLocale')
->willReturn('en_US');
$this->assertRegExp(
Expand Down