Skip to content
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.

Sign up for GitHub

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

Remove dependency of date renderer on global state locale #1469

Merged
merged 1 commit into from
Jul 29, 2015
Merged

Remove dependency of date renderer on global state locale #1469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion app/code/Magento/Reports/Block/Adminhtml/Sales/Grid/Column/Renderer/Date.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ public function render(\Magento\Framework\Object $row)
} else {
$date = $this->_localeDate->date(new \DateTime($data), null, false);
}
return \IntlDateFormatter::formatObject($date, $format);
return \IntlDateFormatter::formatObject($date, $format, $this->_localeResolver->getLocale());
}
return $this->getColumn()->getDefault();
}
Expand Down
106 changes: 78 additions & 28 deletions app/code/Magento/Reports/Test/Unit/Block/Adminhtml/Sales/Grid/Column/Renderer/DateTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,44 @@ class DateTest extends \PHPUnit_Framework_TestCase
*/
protected $localeDate;

/**
* @var string
*/
private $globalStateLocaleBackup;

/**
* @param string $locale
*/
private function mockGridDateRendererBehaviorWithLocale($locale)
{
$this->resolverMock->expects($this->any())->method('getLocale')->willReturn($locale);
$this->localeDate->expects($this->any())->method('getDateFormat')->willReturnCallback(
function ($value) use ($locale) {
return (new \IntlDateFormatter(
$locale,
$value,
\IntlDateFormatter::NONE
))->getPattern();
}
);
}

/**
* @param string $objectDataIndex
* @param string $periodType
*/
private function mockGridDateColumnConfig($objectDataIndex, $periodType)
{
$columnMock = $this->getMockBuilder('Magento\Backend\Block\Widget\Grid\Column')
->disableOriginalConstructor()
->setMethods(['getIndex', 'getPeriodType'])
->getMock();
$columnMock->expects($this->once())->method('getIndex')->willReturn($objectDataIndex);
$columnMock->expects($this->atLeastOnce())->method('getPeriodType')->willReturn($periodType);

$this->date->setColumn($columnMock);
}

/**
* {@inheritDoc}
*/
Expand All @@ -41,15 +79,15 @@ protected function setUp()
$this->localeDate
->expects($this->once())
->method('date')
->will($this->returnArgument(0));
->willReturnArgument(0);

$this->contextMock = $this->getMockBuilder('Magento\Backend\Block\Context')
->disableOriginalConstructor()
->getMock();
$this->contextMock
->expects($this->once())
->method('getLocaleDate')
->will($this->returnValue($this->localeDate));
->willReturn($this->localeDate);

$this->resolverMock = $this->getMockBuilder('Magento\Framework\Locale\ResolverInterface')
->getMock();
Expand All @@ -58,43 +96,41 @@ protected function setUp()
$this->contextMock,
$this->resolverMock
);

$this->globalStateLocaleBackup = \Locale::getDefault();
}

protected function tearDown()
{
$this->restoreTheDefaultLocaleGlobalState();
}

private function restoreTheDefaultLocaleGlobalState()
{
if (\Locale::getDefault() !== $this->globalStateLocaleBackup) {
\Locale::setDefault($this->globalStateLocaleBackup);
}
}

/**
* @param string $data
* @param string $index
* @param string $locale
* @param string $index
* @param string $period
* @param string $result
* @dataProvider datesDataProvider
* @return void
*/
public function testRender($data, $index, $locale, $period, $result)
public function testRender($data, $locale, $index, $period, $result)
{
$this->resolverMock->expects($this->any())->method('getLocale')->will($this->returnValue($locale));
$this->localeDate->expects($this->any())->method('getDateFormat')->willReturnCallback(
function ($value) use ($locale) {
return (new \IntlDateFormatter(
$locale,
$value,
\IntlDateFormatter::NONE
))->getPattern();
}
);
$this->mockGridDateRendererBehaviorWithLocale($locale);
$this->mockGridDateColumnConfig($index, $period);

$objectMock = $this->getMockBuilder('Magento\Framework\Object')
->setMethods(['getData'])
->getMock();
$objectMock->expects($this->once())->method('getData')->will($this->returnValue($data));

$columnMock = $this->getMockBuilder('Magento\Backend\Block\Widget\Grid\Column')
->disableOriginalConstructor()
->setMethods(['getIndex', 'getPeriodType'])
->getMock();
$columnMock->expects($this->once())->method('getIndex')->will($this->returnValue($index));
$columnMock->expects($this->atLeastOnce())->method('getPeriodType')->will($this->returnValue($period));
$objectMock->expects($this->once())->method('getData')->willReturn($data);

$this->date->setColumn($columnMock);

$this->assertEquals($result, $this->date->render($objectMock));
}
Expand All @@ -107,39 +143,53 @@ public function datesDataProvider()
return [
[
'data' => '2000',
'index' => 'period',
'locale' => 'en_US',
'index' => 'period',
'period' => 'year',
'result' => '2000'
],
[
'data' => '2030',
'index' => 'period',
'locale' => 'en_US',
'index' => 'period',
'period' => 'year',
'result' => '2030'
],
[
'data' => '2000-01',
'index' => 'period',
'locale' => 'en_US',
'index' => 'period',
'period' => 'month',
'result' => '1/2000'
],
[
'data' => '2030-12',
'index' => 'period',
'locale' => 'en_US',
'index' => 'period',
'period' => 'month',
'result' => '12/2030'
],
[
'data' => '2014-06-25',
'index' => 'period',
'locale' => 'en_US',
'index' => 'period',
'period' => 'day',
'result' => 'Jun 25, 2014'
]
];
}

public function testDateIsRenderedIndependentOfSystemDefaultLocale()
{
\Locale::setDefault('de_DE');
$this->mockGridDateRendererBehaviorWithLocale('en_US');
$this->mockGridDateColumnConfig('period', 'day');

$objectMock = $this->getMockBuilder('Magento\Framework\Object')
->setMethods(['getData'])
->getMock();
$objectMock->expects($this->any())->method('getData')->willReturn('2014-06-25');

$this->assertEquals('Jun 25, 2014', $this->date->render($objectMock));
}
}