[Intl] Fixed StructuredBundleReader to follow locale aliases when loo…

…king for fallback locales
symfony · webmozart · Oct 2, 2013 · Oct 2, 2013 · Oct 2, 2013 · Oct 2, 2013
commit 95de4382b75a0f21665ff33016332e397195d2b6
diff --git a/UPGRADE-2.4.md b/UPGRADE-2.4.md
@@ -7,3 +7,10 @@ Form
 * The constructor parameter `$precision` in `IntegerToLocalizedStringTransformer`
   is now ignored completely, because a precision does not make sense for
   integers.
+
+Intl
+----
+
+ * A new method `getLocaleAliases()` was added to `LocaleBundleInterface`. If
+   any of your classes implements this interface, you should add an implementation
+   of this method.
diff --git a/src/Symfony/Component/Intl/CHANGELOG.md b/src/Symfony/Component/Intl/CHANGELOG.md
@@ -14,3 +14,5 @@ CHANGELOG
   names when fallback (e.g. "en_GB"->"en") is possible anyway. This reduced
   the Resources/ directory file size of the Icu 1.2.x branch from 14M to 12M at
   the time of this writing
+ * `StructuredBundleReader` now follows aliases when looking for fallback locales
+ * [BC BREAK] a new method `getLocaleAliases()` was added to `LocaleBundleInterface`
diff --git a/src/Symfony/Component/Intl/Intl.php b/src/Symfony/Component/Intl/Intl.php
@@ -215,6 +215,10 @@ private static function getBundleReader()
                IcuData::getBundleReader(),
                self::BUFFER_SIZE
            ));
+
+            // Make sure that self::$bundleReader is already set to prevent
+            // a cycle
+            self::$bundleReader->setLocaleAliases(self::getLocaleBundle()->getLocaleAliases());
        }

        return self::$bundleReader;

diff --git a/src/Symfony/Component/Intl/ResourceBundle/LocaleBundle.php b/src/Symfony/Component/Intl/ResourceBundle/LocaleBundle.php
@@ -32,6 +32,20 @@ public function getLocales()
        return $locales;
    }

+    /**
+     * {@inheritdoc}
+     */
+    public function getLocaleAliases()
+    {
+        $aliases = $this->readEntry('misc', array('Aliases'));
+
+        if ($aliases instanceof \Traversable) {
+            $aliases = iterator_to_array($aliases);
+        }
+
+        return $aliases;
+    }
+
    /**
     * {@inheritdoc}
     */

diff --git a/src/Symfony/Component/Intl/ResourceBundle/LocaleBundleInterface.php b/src/Symfony/Component/Intl/ResourceBundle/LocaleBundleInterface.php
@@ -38,4 +38,12 @@ public function getLocaleName($ofLocale, $locale = null);
     * @return string[] A list of locale names indexed by locale codes.
     */
    public function getLocaleNames($locale = null);
+
+    /**
+     * Returns a list of locale aliases.
+     *
+     * @return array An array with aliases as keys and aliased locales as
+     *               values.
+     */
+    public function getLocaleAliases();
 }
diff --git a/src/Symfony/Component/Intl/ResourceBundle/Reader/StructuredBundleReader.php b/src/Symfony/Component/Intl/ResourceBundle/Reader/StructuredBundleReader.php
@@ -30,6 +30,13 @@ class StructuredBundleReader implements StructuredBundleReaderInterface
     */
    private $reader;

+    /**
+     * A mapping of locale aliases to locales
+     *
+     * @var array
+     */
+    private $localeAliases = array();
+
    /**
     * Creates an entry reader based on the given resource bundle reader.
     *
@@ -40,6 +47,21 @@ public function __construct(BundleReaderInterface $reader)
        $this->reader = $reader;
    }

+    /**
+     * Stores a mapping of locale aliases to locales.
+     *
+     * This mapping is used when reading entries and merging them with their
+     * fallback locales. If an entry is read for a locale alias (e.g. "mo")
+     * that points to a locale with a fallback locale ("ro_MD"), the reader
+     * can continue at the correct fallback locale ("ro").
+     *
+     * @param array $localeAliases A mapping of locale aliases to locales
+     */
+    public function setLocaleAliases($localeAliases)
+    {
+        $this->localeAliases = $localeAliases;
+    }
+
    /**
     * {@inheritdoc}
     */
@@ -108,7 +130,12 @@ public function readEntry($path, $locale, array $indices, $fallback = true)
            // Remember which locales we tried
            $testedLocales[] = $currentLocale.'.res';

-            // Go to fallback locale
+            // First check whether the locale is an alias
+            if (isset($this->localeAliases[$currentLocale])) {
+                $currentLocale = $this->localeAliases[$currentLocale];
+            }
+
+            // Then determine fallback locale
            $currentLocale = Intl::getFallbackLocale($currentLocale);
        }


diff --git a/src/Symfony/Component/Intl/Tests/ResourceBundle/Reader/StructuredBundleReaderTest.php b/src/Symfony/Component/Intl/Tests/ResourceBundle/Reader/StructuredBundleReaderTest.php
@@ -250,4 +250,27 @@ public function testMergeTraversables($childData, $parentData, $result)

        $this->assertSame($result, $this->reader->readEntry(self::RES_DIR, 'en_GB', array('Foo', 'Bar'), true));
    }
+
+    /**
+     * @dataProvider provideMergeableValues
+     */
+    public function testFollowLocaleAliases($childData, $parentData, $result)
+    {
+        $this->reader->setLocaleAliases(array('mo' => 'ro_MD'));
+
+        $this->readerImpl->expects($this->at(0))
+            ->method('read')
+            ->with(self::RES_DIR, 'mo')
+            ->will($this->returnValue(array('Foo' => array('Bar' => $childData))));
+
+        if (null === $childData || is_array($childData)) {
+            // Read fallback locale of aliased locale ("ro_MD" -> "ro")
+            $this->readerImpl->expects($this->at(1))
+                ->method('read')
+                ->with(self::RES_DIR, 'ro')
+                ->will($this->returnValue(array('Foo' => array('Bar' => $parentData))));
+        }
+
+        $this->assertSame($result, $this->reader->readEntry(self::RES_DIR, 'mo', array('Foo', 'Bar'), true));
+    }
 }
-Original file line number
+Diff line change
@@ -38,4 +38,12 @@ public function getLocaleName($ofLocale, $locale = null);
          * @return string[] A list of locale names indexed by locale codes.
          */
         public function getLocaleNames($locale = null);
+        /**
+         * Returns a list of locale aliases.
+         *
+         * @return array An array with aliases as keys and aliased locales as
+         *               values.
+         */
+        public function getLocaleAliases();
             Copy link

  
      
    
  

  
      

  
  Member


      

  

  
    
      

      
            stof
  

      

      

      


        Oct 3, 2013


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      this should be mentionned as a BC break too
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
  


          
          
        
      
    

    



  
        
  
    
        
    
  


      
          
  
      
            Copy link

  
      
    
  

  
      

  
    Contributor


      

  Author


  

  
    
      

      
            webmozart
  

      

      

      


        Oct 4, 2013


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      documented
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
     }