Merge pull request #88 from sebastianludwig/modularization

Pull common formatter code into the AbstractFormatter.

lib/twine/cli.rb

@@ -58,7 +58,7 @@ module Twine
         opts.on('-a', '--consume-all', 'Normally, when consuming a string file, Twine will ignore any string keys that do not exist in your master file.') do |a|
           @options[:consume_all] = true
         end
-        opts.on('-s', '--include-untranslated', 'This flag will cause any Android string files that are generated to include strings that have not yet been translated for the current language.') do |s|
+        opts.on('-s', '--include-untranslated', 'This flag will cause any string files that are generated to include strings that have not yet been translated for the current language.') do |s|
           @options[:include_untranslated] = true
         end
         opts.on('-o', '--output-file OUTPUT_FILE', 'Write the new strings database to this file instead of replacing the original file. This flag is only useful when running the consume-string-file or consume-loc-drop commands.') do |o|

lib/twine/formatters/abstract.rb

@@ -113,8 +113,78 @@ module Twine
         raise NotImplementedError.new("You must implement read_file in your formatter class.")
       end
 
+      def format_file(lang, default_lang)
+        result = format_header(lang) + "\n"
+        result += format_sections(lang, default_lang)
+      end
+
+      def format_header(lang)
+        raise NotImplementedError.new("You must implement format_header in your formatter class.")
+      end
+
+      def format_sections(lang, default_lang)
+        sections = @strings.sections.map { |section| format_section(section, lang, default_lang) }
+        sections.join("\n")
+      end
+
+      def format_section_header(section)
+      end
+
+      def format_section(section, lang, default_lang)
+        rows = section.rows.select { |row| row.matches_tags?(@options[:tags], @options[:untagged]) }
+
+        result = ""
+        unless rows.empty?
+          if section.name && section.name.length > 0
+            section_header = format_section_header(section)
+            result += "\n#{section_header}" if section_header
+          end
+        end
+
+        rows.map! { |row| format_row(row, lang, default_lang) }
+        rows.compact! # remove nil entries
+        rows.map! { |row| "\n#{row}" }  # prepend newline
+        result += rows.join
+      end
+
+      def format_row(row, lang, default_lang)
+        value = row.translated_string_for_lang(lang, default_lang)
+        if value.nil? && @options[:include_untranslated]
+          value = row.translated_string_for_lang(@strings.language_codes[0])
+        end
+        return nil unless value
+
+        result = ""
+        if row.comment
+          comment = format_comment(row.comment)
+          result += comment + "\n" if comment
+        end
+
+        result += key_value_pattern % { key: format_key(row.key.dup), value: format_value(value.dup) }
+      end
+
+      def format_comment(comment)
+      end
+
+      def key_value_pattern
+        raise NotImplementedError.new("You must implement key_value_pattern in your formatter class.")
+      end
+
+      def format_key(key)
+        key
+      end
+
+      def format_value(value)
+        value
+      end
+
       def write_file(path, lang)
-        raise NotImplementedError.new("You must implement write_file in your formatter class.")
+        default_lang = @strings.language_codes[0]
+        encoding = @options[:output_encoding] || 'UTF-8'
+
+        File.open(path, "w:#{encoding}") do |f|
+          f.puts format_file(lang, default_lang)
+        end
       end
 
       def write_all_files(path)

lib/twine/formatters/android.rb

@@ -91,65 +91,43 @@ 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
-
-                key = row.key
-
-                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
-
-                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
-
-          f.puts '</resources>'
-        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
+
+      def format_sections(lang, default_lang)
+        result = '<resources>'
+        
+        result += super(lang, default_lang) + "\n"
+
+        result += '</resources>'
+      end
+
+      def format_section_header(section)
+        "\t<!-- SECTION: #{section.name} -->"
+      end
+
+      def format_comment(comment)
+        "\t<!-- #{comment.gsub('--', '—')} -->"
+      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.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 }
+      end
+
     end
   end
 end

lib/twine/formatters/apple.rb

@@ -82,46 +82,34 @@ 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 * 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(comment)
+        "/* #{comment.gsub('*/', '* /')} */"
+      end
+
+      def format_key(key)
+        escape_quotes(key)
+      end
+
+      def format_value(value)
+        escape_quotes(value)
+      end
+
+      def escape_quotes(text)
+        text.gsub('"', '\\\\"')
+      end
+
     end
   end
 end