Adjust Twine format to OrganicsMaps usages

documentation/assets/formatter.graffle

@@ -172,7 +172,7 @@
 
 \f0\fs36 \cf0 /**\
  * Apple Strings File\
- * Generated by Twine 0.8.1\
+ * Generated by Twine\
  * Language: en\
  */\
 \

documentation/formatters.md

@@ -30,12 +30,6 @@ If we map the _input_ for each method to the example file, it looks like this
 As stated at the beginning, the output produced by a formatter depends on the formatter. The output of the Apple formatter would for example be
 
 ```
-/**
- * Apple Strings File
- * Generated by Twine 0.8.1
- * Language: en
- */
-
 /********** General **********/
 
 "yes" = "Yes";

lib/twine.rb

@@ -31,6 +31,7 @@ class Error < StandardError
   require 'twine/formatters/abstract'
   require 'twine/formatters/android'
   require 'twine/formatters/apple'
+  require 'twine/formatters/apple_plural'
   require 'twine/formatters/django'
   require 'twine/formatters/flash'
   require 'twine/formatters/gettext'

lib/twine/formatters/abstract.rb

@@ -3,6 +3,7 @@
 module Twine
   module Formatters
     class Abstract
+      SUPPORTS_PLURAL = false
       LANGUAGE_CODE_WITH_OPTIONAL_REGION_CODE = "[a-z]{2}(?:-[A-Za-z]{2})?"
 
       attr_accessor :twine_file
@@ -139,7 +140,13 @@ def format_section(section, lang)
       end
 
       def format_definition(definition, lang)
-        [format_comment(definition, lang), format_key_value(definition, lang)].compact.join
+        formatted_definition = [format_comment(definition, lang)]
+        if self.class::SUPPORTS_PLURAL && definition.is_plural?
+          formatted_definition << format_plural(definition, lang)
+        else
+          formatted_definition << format_key_value(definition, lang)
+        end
+        formatted_definition.compact.join
       end
 
       def format_comment(definition, lang)
@@ -150,10 +157,21 @@ def format_key_value(definition, lang)
         key_value_pattern % { key: format_key(definition.key.dup), value: format_value(value.dup) }
       end
 
+      def format_plural(definition, lang)
+        plural_hash = definition.plural_translation_for_lang(lang)
+        if plural_hash
+          format_plural_keys(definition.key.dup, plural_hash)
+        end
+      end
+
       def key_value_pattern
         raise NotImplementedError.new("You must implement key_value_pattern in your formatter class.")
       end
 
+      def format_plural_keys(key, plural_hash)
+        raise NotImplementedError.new("You must implement format_plural_keys in your formatter class.")
+      end
+
       def format_key(key)
         key
       end

lib/twine/formatters/android.rb

@@ -7,6 +7,17 @@ module Formatters
     class Android < Abstract
       include Twine::Placeholders
 
+      SUPPORTS_PLURAL = true
+      LANG_CODES = Hash[
+        'zh' => 'zh-Hans',
+        'zh-CN' => 'zh-Hans',
+        'zh-HK' => 'zh-Hant',
+        # See https://developer.android.com/reference/java/util/Locale#legacy-language-codes
+        'iw' => 'he',
+        'in' => 'id',
+        'ji' => 'yi'
+      ]
+
       def format_name
         'android'
       end
@@ -33,7 +44,10 @@ def determine_language_given_path(path)
             # see http://developer.android.com/guide/topics/resources/providing-resources.html#AlternativeResources
             match = /^values-([a-z]{2}(-r[a-z]{2})?)$/i.match(segment)
 
-            return match[1].sub('-r', '-') if match
+            if match
+              lang = match[1].sub('-r', '-')
+              return LANG_CODES.fetch(lang, lang)
+            end
           end
         end
 
@@ -82,7 +96,7 @@ def read(io, lang)
       end
 
       def format_header(lang)
-        "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<!-- Android Strings File -->\n<!-- Generated by Twine #{Twine::VERSION} -->\n<!-- Language: #{lang} -->"
+        "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
       end
 
       def format_sections(twine_file, lang)
@@ -94,15 +108,25 @@ def format_sections(twine_file, lang)
       end
 
       def format_section_header(section)
-        "\t<!-- SECTION: #{section.name} -->"
+        "#{space(4)}<!-- SECTION: #{section.name} -->"
       end
 
       def format_comment(definition, lang)
-        "\t<!-- #{definition.comment.gsub('--', '—')} -->\n" if definition.comment
+        "#{space(4)}<!-- #{definition.comment.gsub('--', '—')} -->\n" if definition.comment
       end
 
       def key_value_pattern
-        "\t<string name=\"%{key}\">%{value}</string>"
+        "#{space(4)}<string name=\"%{key}\">%{value}</string>"
+      end
+
+      def format_plural_keys(key, plural_hash)
+        result = "#{space(4)}<plurals name=\"#{key}\">\n"
+        result += plural_hash.map{|quantity,value| "#{space(8)}<item quantity=\"#{quantity}\">#{escape_value(value)}</item>"}.join("\n")
+        result += "\n#{space(4)}</plurals>"
+      end
+
+      def space(level)
+        ' ' * level
       end
 
       def gsub_unless(text, pattern, replacement)
@@ -136,6 +160,7 @@ def escape_value(value)
           angle_bracket = /<(?!(\/?(b|em|i|cite|dfn|big|small|font|tt|s|strike|del|u|super|sub|ul|li|br|div|span|p|a|\!\[CDATA)))/
         end
         value = gsub_unless(value, angle_bracket, '&lt;') { |substring| substring =~ inside_cdata }
+        value = gsub_unless(value, '\n', "\n\\n") { |substring| substring =~ inside_cdata }
 
         # escape non resource identifier @ signs (http://developer.android.com/guide/topics/resources/accessing-resources.html#ResourcesFromXml)
         resource_identifier_regex = /@(?!([a-z\.]+:)?[a-z+]+\/[a-zA-Z_]+)/   # @[<package_name>:]<resource_type>/<resource_name>

lib/twine/formatters/apple.rb

@@ -1,6 +1,8 @@
 module Twine
   module Formatters
     class Apple < Abstract
+      include Twine::Placeholders
+
       def format_name
         'apple'
       end
@@ -63,10 +65,6 @@ def read(io, lang)
         end
       end
 
-      def format_header(lang)
-        "/**\n * Apple Strings File\n * Generated by Twine #{Twine::VERSION}\n * Language: #{lang}\n */"
-      end
-
       def format_section_header(section)
         "/********** #{section.name} **********/\n"
       end
@@ -84,8 +82,14 @@ def format_key(key)
       end
 
       def format_value(value)
+        # Replace Android's %s with iOS %@
+        value = convert_placeholders_from_android_to_twine(value)
         escape_quotes(value)
       end
+
+      def should_include_definition(definition, lang)
+        return !definition.is_plural? && super
+      end
     end
   end
 end

lib/twine/formatters/apple_plural.rb

@@ -0,0 +1,72 @@
+module Twine
+  module Formatters
+    class ApplePlural < Apple
+      include Twine::Placeholders
+
+      SUPPORTS_PLURAL = true
+
+      def format_name
+        'apple-plural'
+      end
+
+      def extension
+        '.stringsdict'
+      end
+
+      def default_file_name
+        'Localizable.stringsdict'
+      end
+
+      def format_footer(lang)
+        footer = "</dict>\n</plist>"
+      end
+
+      def format_file(lang)
+        result = super
+        result += format_footer(lang)
+      end
+
+      def format_header(lang)
+        header =  "<\?xml version=\"1.0\" encoding=\"UTF-8\"\?>\n"
+        header += "<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n"
+        header += "<plist version=\"1.0\">\n<dict>"
+      end
+
+      def format_section_header(section)
+        "<!-- ********** #{section.name} **********/ -->\n"
+      end
+
+      def format_plural_keys(key, plural_hash)
+        result = "\t<key>#{key}</key>\n"
+        result += "\t<dict>\n"
+        result += "\t\t<key>NSStringLocalizedFormatKey</key>\n"
+        result += "\t\t<string>\%\#@value@</string>\n"
+        result += "\t\t<key>value</key>\n"
+        result += "\t\t<dict>\n"
+        result += "\t\t\t<key>NSStringFormatSpecTypeKey</key>\n"
+        result += "\t\t\t<string>NSStringPluralRuleType</string>\n"
+        result += "\t\t\t<key>NSStringFormatValueTypeKey</key>\n"
+        result += "\t\t\t<string>d</string>\n"
+        # Replace Android's %s with iOS %@
+        result += plural_hash.map{|quantity,value| "\t\t\t<key>#{quantity}</key>\n\t\t\t<string>#{convert_placeholders_from_android_to_twine(value)}</string>"}.join("\n")
+        result += "\n"
+        result += "\t\t</dict>\n"
+        result += "\t</dict>\n"
+      end
+
+      def format_comment(definition, lang)
+        "<!-- #{definition.comment.gsub('--', '—')} -->\n" if definition.comment
+      end
+
+      def read(io, lang)
+        raise NotImplementedError.new("Reading \".stringdict\" files not implemented yet")
+      end
+
+      def should_include_definition(definition, lang)
+        return definition.is_plural? && definition.plural_translation_for_lang(lang)
+      end
+    end
+  end
+end
+
+Twine::Formatters.formatters << Twine::Formatters::ApplePlural.new

lib/twine/formatters/django.rb

@@ -55,7 +55,7 @@ def format_file(lang)
 
       def format_header(lang)
         # see https://www.gnu.org/software/trans-coord/manual/gnun/html_node/PO-Header.html for details
-        "# Django Strings File\n# Generated by Twine #{Twine::VERSION}\n# Language: #{lang}\nmsgid \"\"\nmsgstr \"\"\n\"Content-Type: text/plain; charset=UTF-8\\n\""
+        "# Django Strings File\n# Generated by Twine\n# Language: #{lang}\nmsgid \"\"\nmsgstr \"\"\n\"Content-Type: text/plain; charset=UTF-8\\n\""
       end
 
       def format_section_header(section)

lib/twine/formatters/flash.rb

@@ -42,7 +42,7 @@ def format_sections(twine_file, lang)
       end
 
       def format_header(lang)
-        "## Flash Strings File\n## Generated by Twine #{Twine::VERSION}\n## Language: #{lang}"
+        "## Flash Strings File\n## Generated by Twine\n## Language: #{lang}"
       end
 
       def format_section_header(section)

lib/twine/formatters/jquery.rb

@@ -14,7 +14,7 @@ def default_file_name
       end
 
       def determine_language_given_path(path)
-        match = /^.+-([^-]{2})\.json$/.match File.basename(path)
+        match = /^.+([a-z]{2}-[A-Z]{2})\.json$/.match File.basename(path)
         return match[1] if match
 
         return super

lib/twine/formatters/tizen.rb

@@ -91,7 +91,7 @@ def read(io, lang)
       end
 
       def format_header(lang)
-        "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<!-- Tizen Strings File -->\n<!-- Generated by Twine #{Twine::VERSION} -->\n<!-- Language: #{lang} -->"
+        "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<!-- Tizen Strings File -->\n<!-- Generated by Twine -->\n<!-- Language: #{lang} -->"
       end
 
       def format_sections(twine_file, lang)

lib/twine/output_processor.rb

@@ -17,7 +17,12 @@ def fallback_languages(language)
           'zh-TW' => 'zh-Hant' # if we don't have a zh-TW translation, try zh-Hant before en
         }
 
-        [fallback_mapping[language], default_language].flatten.compact
+        # Regional dialect fallbacks to generic language (for example: 'es-MX' to 'es' instead of default 'en').
+        if language.match(/([a-zA-Z]{2})-[a-zA-Z]+/)
+          generic_language = language.gsub(/([a-zA-Z])-[a-zA-Z]+/, '\1')
+        end
+
+        [fallback_mapping[language], generic_language, default_language].flatten.compact
       end
 
       def process(language)
@@ -43,6 +48,14 @@ def process(language)
             new_definition = definition.dup
             new_definition.translations[language] = value
 
+            if definition.is_plural?
+              # If definition is plural, but no translation found -> create
+              # Then check 'other' key
+              if !(new_definition.plural_translations[language] ||= {}).key? 'other'
+                new_definition.plural_translations[language]['other'] = value
+              end
+            end
+
             new_section.definitions << new_definition
             result.definitions_by_key[new_definition.key] = new_definition
           end