Merge pull request zendframework/zendframework#5825 from poisa/add/ph…

…pMemoryArray

New class Translator\Loader\PhpMemoryArray

src/Translator/Loader/PhpMemoryArray.php

@@ -0,0 +1,77 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\I18n\Translator\Loader;
+
+use Zend\I18n\Exception;
+use Zend\I18n\Translator\Plural\Rule as PluralRule;
+use Zend\I18n\Translator\TextDomain;
+
+/**
+ * PHP array loader.
+ */
+class PhpMemoryArray implements RemoteLoaderInterface
+{
+    /**
+     * @var array
+     */
+    protected $messages;
+
+    public function __construct($messages)
+    {
+        $this->messages = $messages;
+    }
+
+    /**
+     * Load translations from a remote source.
+     *
+     * @param  string $locale
+     * @param  string $textDomain
+     *
+     * @throws \Zend\I18n\Exception\InvalidArgumentException
+     * @return \Zend\I18n\Translator\TextDomain|null
+     */
+    public function load($locale, $textDomain)
+    {
+        if (!is_array($this->messages)) {
+            throw new Exception\InvalidArgumentException(sprintf(
+                'Expected an array, but received %s',
+                gettype($this->messages)
+            ));
+        }
+
+        if (!isset($this->messages[$textDomain])) {
+            throw new Exception\InvalidArgumentException(sprintf(
+                'Expected textdomain "%s" to be an array, but it is not set',
+                $textDomain)
+            );
+        }
+
+        if (!isset($this->messages[$textDomain][$locale])) {
+            throw new Exception\InvalidArgumentException(sprintf(
+                'Expected locale "%s" to be an array, but it is not set',
+                $locale)
+            );
+        }
+
+        $textDomain = new TextDomain($this->messages[$textDomain][$locale]);
+
+        if (array_key_exists('', $textDomain)) {
+            if (isset($textDomain['']['plural_forms'])) {
+                $textDomain->setPluralRule(
+                    PluralRule::fromString($textDomain['']['plural_forms'])
+                );
+            }
+
+            unset($textDomain['']);
+        }
+
+        return $textDomain;
+    }
+}

test/Translator/Loader/PhpMemoryArrayTest.php

@@ -0,0 +1,90 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace ZendTest\I18n\Translator\Loader;
+
+use PHPUnit_Framework_TestCase as TestCase;
+use Locale;
+use Zend\I18n\Translator\Loader\PhpmemoryArray as PhpMemoryArrayLoader;
+
+class PhpMemoryArrayTest extends TestCase
+{
+    protected $testFilesDir;
+    protected $originalLocale;
+    protected $originalIncludePath;
+
+    public function setUp()
+    {
+        if (!extension_loaded('intl')) {
+            $this->markTestSkipped('ext/intl not enabled');
+        }
+
+        $this->originalLocale = Locale::getDefault();
+        Locale::setDefault('en_US');
+
+        $this->testFilesDir = realpath(__DIR__ . '/../_files/phpmemoryarray');
+    }
+
+    public function tearDown()
+    {
+        if (extension_loaded('intl')) {
+            Locale::setDefault($this->originalLocale);
+        }
+    }
+    public function testLoaderFailsToLoadNonArray()
+    {
+        $loader = new PhpMemoryArrayLoader('foo');
+        $this->setExpectedException('Zend\I18n\Exception\InvalidArgumentException',
+                                    'Expected an array, but received');
+        $loader->load('en_US', 'default');
+    }
+
+    public function testLoaderFailsToLoadMissingTextDomain()
+    {
+        $loader = new PhpMemoryArrayLoader(array());
+        $this->setExpectedException('Zend\I18n\Exception\InvalidArgumentException',
+                                    'Expected textdomain "default" to be an array, but it is not set');
+        $loader->load('en_US', 'default');
+    }
+
+    public function testLoaderFailsToLoadNonArrayLocale()
+    {
+        $loader = new PhpMemoryArrayLoader(array('default' => array()));
+        $this->setExpectedException('Zend\I18n\Exception\InvalidArgumentException',
+                                    'Expected locale "en_US" to be an array, but it is not set');
+        $loader->load('en_US', 'default');
+    }
+
+    public function testLoaderLoadsEmptyArray()
+    {
+        $loader = new PhpMemoryArrayLoader(include $this->testFilesDir . '/translation_empty.php');
+        $textDomain = $loader->load('en_US', 'default');
+        $this->assertInstanceOf('Zend\I18n\Translator\TextDomain', $textDomain);
+    }
+
+    public function testLoaderReturnsValidTextDomain()
+    {
+        $loader = new PhpMemoryArrayLoader(include $this->testFilesDir . '/translation_en.php');
+        $textDomain = $loader->load('en_US', 'default');
+
+        $this->assertEquals('Message 1 (en)', $textDomain['Message 1']);
+        $this->assertEquals('Message 4 (en)', $textDomain['Message 4']);
+    }
+
+    public function testLoaderLoadsPluralRules()
+    {
+        $loader     = new PhpMemoryArrayLoader(include $this->testFilesDir . '/translation_en.php');
+        $textDomain = $loader->load('en_US', 'default');
+
+        $this->assertEquals(2, $textDomain->getPluralRule()->evaluate(0));
+        $this->assertEquals(0, $textDomain->getPluralRule()->evaluate(1));
+        $this->assertEquals(1, $textDomain->getPluralRule()->evaluate(2));
+        $this->assertEquals(2, $textDomain->getPluralRule()->evaluate(10));
+    }
+}

test/Translator/_files/phpmemoryarray/translation_empty.php

@@ -0,0 +1,15 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+return array(
+    'default' => array(
+        'en_US' => array(
+        ),
+    ),
+);

test/Translator/_files/phpmemoryarray/translation_en.php

@@ -0,0 +1,29 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+return array(
+    'default' => array(
+        'en_US' => array(
+            '' => array(
+                'plural_forms' => 'nplurals=3; plural=(n%10==1 && n%100!=11 ? 0 : n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2);'
+            ),
+            'Message 1' => 'Message 1 (en)',
+            'Message 2' => 'Message 2 (en)',
+            'Message 3' => 'Message 3 (en)',
+            'Message 4' => 'Message 4 (en)',
+            'Message 5' => array(
+                0 => 'Message 5 (en) Plural 0',
+                1 => 'Message 5 (en) Plural 1',
+                2 => 'Message 5 (en) Plural 2'
+            ),
+            'Cooking furniture' => 'Küchen Möbel (en)',
+            'Küchen Möbel' => 'Cooking furniture (en)',
+        ),
+    ),
+);