Compile plural strings to android <plurals> elem

grit/format/android_xml.py

 #!/usr/bin/env python
 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Produces localized strings.xml files for Android.
 
 In cases where an "android" type output file is requested in a grd, the classes
 in android_xml will process the messages and translations to produce a valid
 strings.xml that is properly localized with the specified language.
@@ skipping 78 matching lines @@
 
 
 # In most cases we only need a name attribute and string value.
 _SIMPLE_TEMPLATE = u'<string name="%s">%s</string>\n'
 
 
 # In a few cases a product attribute is needed.
 _PRODUCT_TEMPLATE = u'<string name="%s" product="%s">%s</string>\n'
 
 
+# Some strings have a plural equivalent
+_PLURALS_TEMPLATE = '<plurals name="%s">\n%s</plurals>\n'
+_PLURALS_ITEM_TEMPLATE = ' <item quantity="%s">%s</item>\n'
+
+
 def Format(root, lang='en', output_dir='.'):
+  import sys
+  sys.stderr.write('outputting to %s\n' % output_dir)

[newt (away), 2015/08/03 23:06:40]

Looks like debugging code. Remove this?

[conleyo, 2015/08/04 00:27:52]

Done.

   yield ('<?xml version="1.0" encoding="utf-8"?>\n'
           '<resources '
           'xmlns:android="http://schemas.android.com/apk/res/android">\n')
 
   tagged_only = _TAGGED_ONLY_DEFAULT
   if _TAGGED_ONLY_ENV_VAR in os.environ:
     tagged_only = os.environ[_TAGGED_ONLY_ENV_VAR].lower()
     if tagged_only == 'true':
       tagged_only = True
     elif tagged_only == 'false':
@@ skipping 14 matching lines @@
   """Returns true if node should be outputted.
 
   Args:
       node: a Node from the grd dom
       tagged_only: true, if only tagged messages should be outputted
   """
   return (isinstance(node, message.MessageNode) and
           (not tagged_only or _EMIT_TAG in node.formatter_data))
 
 
+def _LoadPluralMessage(message):

[newt (away), 2015/08/03 23:06:40]

Please add a docstring comment. This method is far from trivial and its working
aren't obvious from the name. In particular, I think you should include the
example inputs and outputs you gave in commit message.

[conleyo, 2015/08/04 00:27:52]

Done.

+  import re

[newt (away), 2015/08/03 23:06:40]

move import to top of file

[conleyo, 2015/08/04 00:27:52]

Done.

+  ret = {}
+  plural_match = re.match(r'\{[A-Z_]+,\s*plural,(.*)\}$', message, re.S)

[newt (away), 2015/08/03 23:06:40]

Pre-compile these patterns, since they're used so many times. Grit has a class
called lazy_re that you should use.

[conleyo, 2015/08/04 00:27:52]

Done.

+  if not plural_match:
+    return None
+  body = plural_match.group(1).strip()

[newt (away), 2015/08/03 23:06:40]

To make this more readable, I'd suggest naming the groups, e.g. (?P<mygroup>\w+)

[conleyo, 2015/08/04 00:27:53]

Done.

+  for item_match in re.finditer(r'(.*)\s*\{(.*?)\}', body):

[newt (away), 2015/08/03 23:06:40]

I'd replace the initial .* with \S+ since you want to match only non-whitespace
characters.

[conleyo, 2015/08/04 00:27:52]

Done.

+    quantity = item_match.group(1)
+    value = item_match.group(2).replace('#', '%d')
+    number_match = re.match(r'=(.*)', quantity)

[newt (away), 2015/08/03 23:06:40]

Explicit checks here would be better, e.g.

  if quantity == '=0':
    ret['zero'] = value
  ...
  elif quantity == 'other':
    ret['other'] = value

You should also check for "few" and "many". Since Android doesn't support any
values except zero, one, two, few, many, other, we should raise an Exception if
the quantity is something else (rather than wait for a runtime failure).

[conleyo, 2015/08/04 00:27:52]

Done.

+    if number_match:
+      number = number_match.group(1).strip()
+      if number == '0':
+        ret['zero'] = value
+      elif number == '1':
+        ret['one'] = value
+      elif number == '2':
+        ret['two'] = value
+      else:
+        ret[number] = value
+    else:
+      ret['other'] = value
+  return ret
+
+
 def _FormatMessage(item, lang):
   """Writes out a single string as a <resource/> element."""
 
   value = item.ws_at_start + item.Translate(lang) + item.ws_at_end
+  plurals = _LoadPluralMessage(value)

[newt (away), 2015/08/03 23:06:40]

How about calling this _FormatPluralMessage() and moving the logic in lines
191-194 into it? It could return None if the message isn't a plural, or the
formatted result if it is a plural.

[conleyo, 2015/08/04 00:27:52]

Done.

   # Replace < > & with &lt; &gt; &amp; to ensure we generate valid XML and
   # replace ' " with \' \" to conform to Android's string formatting rules.
   value = xml.sax.saxutils.escape(value, {"'": "\\'", '"': '\\"'})

[newt (away), 2015/08/03 23:06:40]

these replacements need to happen even for plural messages. (but the line below
should only happen for non-plural messages)

[conleyo, 2015/08/04 00:27:52]

Done.

   # Wrap the string in double quotes to preserve whitespace.
   value = '"' + value + '"'
 
   mangled_name = item.GetTextualIds()[0]
   match = _NAME_PATTERN.match(mangled_name)
   if not match:
     raise Exception('Unexpected resource name: %s' % mangled_name)
   name = match.group('name').lower()
   product = match.group('product')
 
   # Override product or name with values in formatter_data, if any.
   product = item.formatter_data.get(_PRODUCT_TAG, product)
   name = item.formatter_data.get(_NAME_TAG, name)
 
-  if product:
+
+  if plurals:
+    items = ''
+    for quantity, item_value in plurals.items():
+      items += _PLURALS_ITEM_TEMPLATE % (quantity, item_value)
+    return _PLURALS_TEMPLATE % (name, items)
+  elif product:
     return _PRODUCT_TEMPLATE % (name, product, value)
   else:
     return _SIMPLE_TEMPLATE % (name, value)