twine 0.7.0 → 0.8.0

data/lib/twine/formatters/android.rb

@@ -5,6 +5,8 @@ require 'rexml/document'
 module Twine
   module Formatters
     class Android < Abstract
+      include Twine::Placeholders
+
       FORMAT_NAME = 'android'
       EXTENSION = '.xml'
       DEFAULT_FILE_NAME = 'strings.xml'
@@ -17,9 +19,6 @@ module Twine
         'nb' => 'no'
         # TODO: spanish
       ]
-      DEFAULT_LANG_CODES = Hash[
-        'zh-TW' => 'zh-Hant' # if we don't have a zh-TW translation, try zh-Hant before en
-      ]
 
       def self.can_handle_directory?(path)
         Dir.entries(path).any? { |item| /^values.*$/.match(item) }
@@ -48,6 +47,16 @@ module Twine
         return
       end
 
+      def set_translation_for_key(key, lang, value)
+        value = CGI.unescapeHTML(value)
+        value.gsub!('\\\'', '\'')
+        value.gsub!('\\"', '"')
+        value = convert_placeholders_from_android_to_twine(value)
+        value.gsub!('\@', '@')
+        value.gsub!(/(\\u0020)*|(\\u0020)*\z/) { |spaces| ' ' * (spaces.length / 6) }
+        super(key, lang, value)
+      end
+
       def read_file(path, lang)
         resources_regex = /<resources(?:[^>]*)>(.*)<\/resources>/m
         key_regex = /<string name="(\w+)">/
@@ -65,16 +74,8 @@ module Twine
               if key_match
                 key = key_match[1]
                 value_match = value_regex.match(line)
-                if value_match
-                  value = value_match[1]
-                  value = CGI.unescapeHTML(value)
-                  value.gsub!('\\\'', '\'')
-                  value.gsub!('\\"', '"')
-                  value = iosify_substitutions(value)
-                  value.gsub!(/(\\u0020)*|(\\u0020)*\z/) { |spaces| ' ' * (spaces.length / 6) }
-                else
-                  value = ""
-                end
+                value = value_match ? value_match[1] : ""
+                
                 set_translation_for_key(key, lang, value)
                 if comment and comment.length > 0 and !comment.start_with?("SECTION:")
                   set_comment_for_key(key, comment)
@@ -91,65 +92,46 @@ module Twine
         end
       end
 
-      def write_file(path, lang)
-        default_lang = nil
-        if DEFAULT_LANG_CODES.has_key?(lang)
-          default_lang = DEFAULT_LANG_CODES[lang]
-        end
-        File.open(path, 'w:UTF-8') do |f|
-          f.puts "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<!-- Android Strings File -->\n<!-- Generated by Twine #{Twine::VERSION} -->\n<!-- Language: #{lang} -->"
-          f.write '<resources>'
-          @strings.sections.each do |section|
-            printed_section = false
-            section.rows.each do |row|
-              if row.matches_tags?(@options[:tags], @options[:untagged])
-                if !printed_section
-                  f.puts ''
-                  if section.name && section.name.length > 0
-                    section_name = section.name.gsub('--', '—')
-                    f.puts "\t<!-- SECTION: #{section_name} -->"
-                  end
-                  printed_section = true
-                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} -->"
+      end
 
-                key = row.key
+      def format_sections(strings, lang)
+        result = '<resources>'
+        
+        result += super + "\n"
 
-                value = row.translated_string_for_lang(lang, default_lang)
-                if !value && @options[:include_untranslated]
-                  value = row.translated_string_for_lang(@strings.language_codes[0])
-                end
+        result += '</resources>'
+      end
 
-                if value # if values is nil, there was no appropriate translation, so let Android handle the defaulting
-                  value = String.new(value) # use a copy to prevent modifying the original
-
-                  # Android enforces the following rules on the values
-                  #  1) apostrophes and quotes must be escaped with a backslash
-                  value.gsub!('\'', '\\\\\'')
-                  value.gsub!('"', '\\\\"')
-                  #  2) HTML escape the string
-                  value = CGI.escapeHTML(value)
-                  #  3) fix substitutions (e.g. %s/%@)
-                  value = androidify_substitutions(value)
-                  #  4) replace beginning and end spaces with \0020. Otherwise Android strips them.
-                  value.gsub!(/\A *| *\z/) { |spaces| '\u0020' * spaces.length }
-
-                  comment = row.comment
-                  if comment
-                    comment = comment.gsub('--', '—')
-                  end
-
-                  if comment && comment.length > 0
-                    f.puts "\t<!-- #{comment} -->\n"
-                  end
-                  f.puts "\t<string name=\"#{key}\">#{value}</string>"
-                end
-              end
-            end
-          end
+      def format_section_header(section)
+        "\t<!-- SECTION: #{section.name} -->"
+      end
 
-          f.puts '</resources>'
-        end
+      def format_comment(row, lang)
+        "\t<!-- #{row.comment.gsub('--', '—')} -->\n" if row.comment
       end
+
+      def key_value_pattern
+        "\t<string name=\"%{key}\">%{value}</string>"
+      end
+
+      def format_value(value)
+        # Android enforces the following rules on the values
+        #  1) apostrophes and quotes must be escaped with a backslash
+        value = escape_quotes(value)
+        value.gsub!("'", "\\\\'")
+        #  2) HTML escape the string
+        value = CGI.escapeHTML(value)
+        #  3) convert placeholders (e.g. %@ -> %s)
+        value = convert_placeholders_from_twine_to_android(value)
+        #  4) 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>
+        value.gsub!(resource_identifier_regex, '\@')
+        #  5) replace beginning and end spaces with \0020. Otherwise Android strips them.
+        value.gsub(/\A *| *\z/) { |spaces| '\u0020' * spaces.length }
+      end
+
     end
   end
 end

data/lib/twine/formatters/apple.rb

@@ -27,6 +27,10 @@ module Twine
         return
       end
 
+      def output_path_for_language(lang)
+        "#{lang}.lproj"
+      end
+
       def read_file(path, lang)
         encoding = Twine::Encoding.encoding_for_path(path)
         sep = nil
@@ -64,63 +68,45 @@ module Twine
               key.gsub!('\\"', '"')
               value = match[2]
               value.gsub!('\\"', '"')
-              value = iosify_substitutions(value)
               set_translation_for_key(key, lang, value)
               if last_comment
                 set_comment_for_key(key, last_comment)
               end
             end
-            if @options[:consume_comments]
-              match = /\/\* (.*) \*\//.match(line)
-              if match
-                last_comment = match[1]
-              else
-                last_comment = nil
-              end
+
+            match = /\/\* (.*) \*\//.match(line)
+            if match
+              last_comment = match[1]
+            else
+              last_comment = nil
             end
+
           end
         end
       end
 
-      def write_file(path, lang)
-        default_lang = @strings.language_codes[0]
-        encoding = @options[:output_encoding] || 'UTF-8'
-        File.open(path, "w:#{encoding}") do |f|
-          f.puts "/**\n * Apple Strings File\n * Generated by Twine #{Twine::VERSION}\n * Language: #{lang}\n */"
-          @strings.sections.each do |section|
-            printed_section = false
-            section.rows.each do |row|
-              if row.matches_tags?(@options[:tags], @options[:untagged])
-                f.puts ''
-                if !printed_section
-                  if section.name && section.name.length > 0
-                    f.print "/********** #{section.name} **********/\n\n"
-                  end
-                  printed_section = true
-                end
-
-                key = row.key
-                key = key.gsub('"', '\\\\"')
-
-                value = row.translated_string_for_lang(lang, default_lang)
-                if value
-                  value = value.gsub('"', '\\\\"')
-
-                  comment = row.comment
-                  if comment
-                    comment = comment.gsub('*/', '* /')
-                  end
-
-                  if comment && comment.length > 0
-                    f.print "/* #{comment} */\n"
-                  end
-
-                  f.print "\"#{key}\" = \"#{value}\";\n"
-                end
-              end
-            end
-          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
+
+      def key_value_pattern
+        "\"%{key}\" = \"%{value}\";\n"
+      end
+
+      def format_comment(row, lang)
+        "/* #{row.comment.gsub('*/', '* /')} */\n" if row.comment
+      end
+
+      def format_key(key)
+        escape_quotes(key)
+      end
+
+      def format_value(value)
+        escape_quotes(value)
       end
     end
   end

data/lib/twine/formatters/django.rb

@@ -26,7 +26,7 @@ module Twine
       end
 
       def read_file(path, lang)
-        comment_regex = /#.? *"(.*)"$/
+        comment_regex = /#\. *"?(.*)"?$/
         key_regex = /msgid *"(.*)"$/
         value_regex = /msgstr *"(.*)"$/m
 
@@ -60,14 +60,12 @@ module Twine
                 line = Iconv.iconv('UTF-8', encoding, line).join
               end
             end
-            if @options[:consume_comments]
-               comment_match = comment_regex.match(line)
-               if comment_match
-                   comment = comment_match[1]
-               end
-            else
-                comment = nil
+            
+            comment_match = comment_regex.match(line)
+            if comment_match
+              comment = comment_match[1]
             end
+
             key_match = key_regex.match(line)
             if key_match
                 key = key_match[1].gsub('\\"', '"')
@@ -83,6 +81,8 @@ module Twine
                 if comment and comment.length > 0 and !comment.start_with?("--------- ")
                     set_comment_for_key(key, comment)
                 end
+                key = nil
+                value = nil
                 comment = nil
             end
 
@@ -90,53 +90,43 @@ module Twine
         end
       end
 
-      def write_file(path, lang)
-        default_lang = @strings.language_codes[0]
-        encoding = @options[:output_encoding] || 'UTF-8'
-        File.open(path, "w:#{encoding}") do |f|
-          f.puts "##\n # Django Strings File\n # Generated by Twine #{Twine::VERSION}\n # Language: #{lang}\n "
-          @strings.sections.each do |section|
-            printed_section = false
-            section.rows.each do |row|
-              if row.matches_tags?(@options[:tags], @options[:untagged])
-                f.puts ''
-                if !printed_section
-                  if section.name && section.name.length > 0
-                    f.print "#--------- #{section.name} ---------#\n\n"
-                  end
-                  printed_section = true
-                end
-                
-                basetrans = row.translated_string_for_lang(default_lang)
+      def format_file(strings, lang)
+        @default_lang = strings.language_codes[0]
+        super
+      end
 
-                key = row.key
-                key = key.gsub('"', '\\\\"')
+      def format_header(lang)
+        "##\n # Django Strings File\n # Generated by Twine #{Twine::VERSION}\n # Language: #{lang}\n"
+      end
 
-                value = row.translated_string_for_lang(lang, default_lang)
-                if value
-                  value = value.gsub('"', '\\\\"')
+      def format_section_header(section)
+        "#--------- #{section.name} ---------#\n"
+      end
 
-                  comment = row.comment
+      def row_pattern
+        "%{comment}%{base_translation}%{key_value}"
+      end
 
-                  if comment
-                     comment = comment.gsub('"', '\\\\"')
-                  end
+      def format_base_translation(row, lang)
+        base_translation = row.translations[@default_lang]
+        "# base translation: \"#{base_translation}\"\n" if base_translation
+      end
 
-                  if comment && comment.length > 0
-                    f.print "#. #{comment} \n"
-                  end
+      def key_value_pattern
+        "msgid \"%{key}\"\n" +
+        "msgstr \"%{value}\"\n"
+      end
 
-                  if basetrans && basetrans.length > 0
-                    f.print "# base translation: \"#{basetrans}\"\n"
-                  end
+      def format_comment(row, lang)
+        "#. #{escape_quotes(row.comment)}\n" if row.comment
+      end
 
-                  f.print "msgid \"#{key}\"\n"
-                  f.print "msgstr \"#{value}\"\n"
-                end
-              end
-            end
-          end
-        end
+      def format_key(key)
+        escape_quotes(key)
+      end
+
+      def format_value(value)
+        escape_quotes(value)
       end
     end
   end

data/lib/twine/formatters/flash.rb

@@ -51,59 +51,44 @@ module Twine
             match = /((?:[^"\\]|\\.)+)\s*=\s*((?:[^"\\]|\\.)*)/.match(line)
             if match
               key = match[1]
-              value = match[2]
+              value = match[2].strip
               value.gsub!(/\{[0-9]\}/, '%@')
               set_translation_for_key(key, lang, value)
               if last_comment
                 set_comment_for_key(key, last_comment)
               end
             end
-            if @options[:consume_comments]
-              match = /#(.*)/.match(line)
-              if match
-                last_comment = match[1]
-              else
-                last_comment = nil
-              end
+            
+            match = /# *(.*)/.match(line)
+            if match
+              last_comment = match[1]
+            else
+              last_comment = nil
             end
+
           end
         end
       end
 
-      def write_file(path, lang)
-        default_lang = @strings.language_codes[0]
-        encoding = @options[:output_encoding] || 'UTF-8'
-        File.open(path, "w:#{encoding}") do |f|
-          f.puts "## Flash Strings File\n## Generated by Twine #{Twine::VERSION}\n## Language: #{lang}\n"
-          @strings.sections.each do |section|
-            printed_section = false
-            section.rows.each do |row|
-              if row.matches_tags?(@options[:tags], @options[:untagged])
-                f.puts ''
-                if !printed_section
-                  if section.name && section.name.length > 0
-                    f.print "## #{section.name} ##\n\n"
-                  end
-                  printed_section = true
-                end
+      def format_header(lang)
+        "## Flash Strings File\n## Generated by Twine #{Twine::VERSION}\n## Language: #{lang}"
+      end
 
-                key = row.key
-                value = row.translated_string_for_lang(lang, default_lang)
-                if value
-                  placeHolderNumber = -1
-                  value = value.gsub(/%[d@]/) { placeHolderNumber += 1; '{%d}' % placeHolderNumber }
-                  
-                  comment = row.comment
-                  if comment && comment.length > 0
-                    f.print "# #{comment}\n"
-                  end
+      def format_section_header(section)
+        "## #{section.name} ##\n"
+      end
 
-                  f.print "#{key}=#{value}"
-                end
-              end
-            end
-          end
-        end
+      def format_comment(row, lang)
+        "# #{row.comment}\n" if row.comment
+      end
+
+      def key_value_pattern
+        "%{key}=%{value}"
+      end
+
+      def format_value(value)
+        placeHolderNumber = -1
+        value.gsub(/%[d@]/) { placeHolderNumber += 1; '{%d}' % placeHolderNumber }
       end
     end
   end