From d7150521f8379c648e9b8109b70409f73bbb7360 Mon Sep 17 00:00:00 2001 From: Sebastian Ludwig Date: Mon, 24 Aug 2015 09:04:50 +0200 Subject: [PATCH 1/6] First refactoring towards modularized formatters. --- lib/twine/formatters/apple.rb | 79 ++++++++++++++++++++++------------- 1 file changed, 50 insertions(+), 29 deletions(-) diff --git a/lib/twine/formatters/apple.rb b/lib/twine/formatters/apple.rb index 87cde45..05f9c48 100644 --- a/lib/twine/formatters/apple.rb +++ b/lib/twine/formatters/apple.rb @@ -82,46 +82,67 @@ module Twine end end + def escape_quotes(text) + text.gsub('"', '\\\\"') + end + + def format_header(lang) + "/**\n * Apple Strings File\n * Generated by Twine #{Twine::VERSION}\n * Language: #{lang}\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 format_row(row, lang, default_lang) + value = row.translated_string_for_lang(lang, default_lang) + return nil unless value + + result = "" + result += format_comment(row.comment) + "\n" if row.comment + + result += "\"#{format_key(row.key)}\" = \"#{format_value(value)}\";\n" + 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 */" + f.puts format_header(lang) + @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 + rows = section.rows.select { |row| row.matches_tags?(@options[:tags], @options[:untagged]) } - 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 + unless rows.empty? + f.puts '' + if section.name && section.name.length > 0 + f.puts "/********** #{section.name} **********/" end end + + rows.each do |row| + f.puts '' + + formatted_row = format_row(row, lang, default_lang) + + f.puts formatted_row if formatted_row + end + end + end + end + end end end From 46d71accbc09332415c81867d8ec60ee886cd6dd Mon Sep 17 00:00:00 2001 From: Sebastian Ludwig Date: Mon, 24 Aug 2015 09:05:10 +0200 Subject: [PATCH 2/6] Finished modularizing apple formatter. --- lib/twine/formatters/apple.rb | 69 +++++++++++++++++++---------------- 1 file changed, 37 insertions(+), 32 deletions(-) diff --git a/lib/twine/formatters/apple.rb b/lib/twine/formatters/apple.rb index 05f9c48..d2d378d 100644 --- a/lib/twine/formatters/apple.rb +++ b/lib/twine/formatters/apple.rb @@ -86,10 +86,46 @@ module Twine text.gsub('"', '\\\\"') end + def format_file(lang, default_lang) + result = format_header(lang) + "\n" + + sections = @strings.sections.map { |section| format_section(section, lang, default_lang) } + result += sections.join("\n") + 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} **********/" if section.name && section.name.length > 0 + end + + def format_section(section, lang, default_lang) + rows = section.rows.select { |row| row.matches_tags?(@options[:tags], @options[:untagged]) } + + result = "" + unless rows.empty? + section_header = format_section_header(section) + result += "\n#{section_header}\n" if section_header + end + + rows.map! { |row| format_row(row, lang, default_lang) } + rows.compact! # remove nil entries + rows.map! { |row| "\n#{row}\n" } # wrap with newlines + result += rows.join + end + + def format_row(row, lang, default_lang) + value = row.translated_string_for_lang(lang, default_lang) + return nil unless value + + result = "" + result += format_comment(row.comment) + "\n" if row.comment + + result += "\"#{format_key(row.key)}\" = \"#{format_value(value)}\";" + end + def format_comment(comment) "/* #{comment.gsub('*/', '* /')} */" end @@ -102,43 +138,12 @@ module Twine escape_quotes(value) end - def format_row(row, lang, default_lang) - value = row.translated_string_for_lang(lang, default_lang) - return nil unless value - - result = "" - result += format_comment(row.comment) + "\n" if row.comment - - result += "\"#{format_key(row.key)}\" = \"#{format_value(value)}\";\n" - 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 format_header(lang) - - @strings.sections.each do |section| - rows = section.rows.select { |row| row.matches_tags?(@options[:tags], @options[:untagged]) } - - unless rows.empty? - f.puts '' - if section.name && section.name.length > 0 - f.puts "/********** #{section.name} **********/" - end - end - - rows.each do |row| - f.puts '' - - formatted_row = format_row(row, lang, default_lang) - - f.puts formatted_row if formatted_row - end - - end - + f.puts format_file(lang, default_lang) end end From eab588735ffd87ada9c4b98265c744c16dc91985 Mon Sep 17 00:00:00 2001 From: Sebastian Ludwig Date: Mon, 24 Aug 2015 09:05:18 +0200 Subject: [PATCH 3/6] Moved formatting sceleton code to Abstract. --- lib/twine/formatters/abstract.rb | 66 +++++++++++++++++++++++++++++++- lib/twine/formatters/apple.rb | 46 ++-------------------- 2 files changed, 69 insertions(+), 43 deletions(-) diff --git a/lib/twine/formatters/abstract.rb b/lib/twine/formatters/abstract.rb index 4d6d844..905b6b7 100644 --- a/lib/twine/formatters/abstract.rb +++ b/lib/twine/formatters/abstract.rb @@ -113,8 +113,72 @@ 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" + + sections = @strings.sections.map { |section| format_section(section, lang, default_lang) } + result += sections.join("\n") + end + + def format_header(lang) + raise NotImplementedError.new("You must implement format_header in your formatter class.") + 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}\n" if section_header + end + end + + rows.map! { |row| format_row(row, lang, default_lang) } + rows.compact! # remove nil entries + rows.map! { |row| "\n#{row}\n" } # wrap with newlines + result += rows.join + end + + def format_row(row, lang, default_lang) + value = row.translated_string_for_lang(lang, default_lang) + 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), value: format_value(value) } + 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) + raise NotImplementedError.new("You must implement format_key in your formatter class.") + end + + def format_value(value) + raise NotImplementedError.new("You must implement format_value in your formatter class.") + 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) diff --git a/lib/twine/formatters/apple.rb b/lib/twine/formatters/apple.rb index d2d378d..fbb7719 100644 --- a/lib/twine/formatters/apple.rb +++ b/lib/twine/formatters/apple.rb @@ -82,17 +82,6 @@ module Twine end end - def escape_quotes(text) - text.gsub('"', '\\\\"') - end - - def format_file(lang, default_lang) - result = format_header(lang) + "\n" - - sections = @strings.sections.map { |section| format_section(section, lang, default_lang) } - result += sections.join("\n") - end - def format_header(lang) "/**\n * Apple Strings File\n * Generated by Twine #{Twine::VERSION}\n * Language: #{lang}\n */" end @@ -101,29 +90,8 @@ module Twine "/********** #{section.name} **********/" if section.name && section.name.length > 0 end - def format_section(section, lang, default_lang) - rows = section.rows.select { |row| row.matches_tags?(@options[:tags], @options[:untagged]) } - - result = "" - unless rows.empty? - section_header = format_section_header(section) - result += "\n#{section_header}\n" if section_header - end - - rows.map! { |row| format_row(row, lang, default_lang) } - rows.compact! # remove nil entries - rows.map! { |row| "\n#{row}\n" } # wrap with newlines - result += rows.join - end - - def format_row(row, lang, default_lang) - value = row.translated_string_for_lang(lang, default_lang) - return nil unless value - - result = "" - result += format_comment(row.comment) + "\n" if row.comment - - result += "\"#{format_key(row.key)}\" = \"#{format_value(value)}\";" + def key_value_pattern + "\"%{key}\" = \"%{value}\";" end def format_comment(comment) @@ -138,14 +106,8 @@ module Twine escape_quotes(value) 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 format_file(lang, default_lang) - end - + def escape_quotes(text) + text.gsub('"', '\\\\"') end end From b06b4f6f6b2577af5449323a7703d0b806142749 Mon Sep 17 00:00:00 2001 From: Sebastian Ludwig Date: Mon, 24 Aug 2015 09:05:26 +0200 Subject: [PATCH 4/6] Half way there of moving android formatter the the modularized version --- lib/twine/formatters/abstract.rb | 13 +++-- lib/twine/formatters/android.rb | 94 +++++++++++++++----------------- lib/twine/formatters/apple.rb | 4 +- 3 files changed, 53 insertions(+), 58 deletions(-) diff --git a/lib/twine/formatters/abstract.rb b/lib/twine/formatters/abstract.rb index 905b6b7..17a2115 100644 --- a/lib/twine/formatters/abstract.rb +++ b/lib/twine/formatters/abstract.rb @@ -115,15 +115,18 @@ module Twine def format_file(lang, default_lang) result = format_header(lang) + "\n" - - sections = @strings.sections.map { |section| format_section(section, lang, default_lang) } - result += sections.join("\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 @@ -134,13 +137,13 @@ module Twine unless rows.empty? if section.name && section.name.length > 0 section_header = format_section_header(section) - result += "\n#{section_header}\n" if section_header + 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}\n" } # wrap with newlines + rows.map! { |row| "\n#{row}" } # prepend newline result += rows.join end diff --git a/lib/twine/formatters/android.rb b/lib/twine/formatters/android.rb index 92cbcaa..d300a28 100644 --- a/lib/twine/formatters/android.rb +++ b/lib/twine/formatters/android.rb @@ -91,65 +91,57 @@ 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] + def format_header(lang) + "\n\n\n" + end + + def format_section_header(section) + "\t" + end + + def format_row(row, lang, default_lang) + result = "" + 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 - File.open(path, 'w:UTF-8') do |f| - f.puts "\n\n\n" - f.write '' - @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" - end - printed_section = true - end - key = row.key + 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 - 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 + # 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 } - 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\n" - end - f.puts "\t#{value}" - end - end - end + comment = row.comment + if comment + comment = comment.gsub('--', '—') end - f.puts '' + if comment && comment.length > 0 + result += "\t\n" + end + result += "\t#{value}" end end + + def format_sections(lang, default_lang) + result = '' + + result += super(lang, default_lang) + "\n" + + result += '' + end + end end end diff --git a/lib/twine/formatters/apple.rb b/lib/twine/formatters/apple.rb index fbb7719..9ff0b86 100644 --- a/lib/twine/formatters/apple.rb +++ b/lib/twine/formatters/apple.rb @@ -87,11 +87,11 @@ module Twine end def format_section_header(section) - "/********** #{section.name} **********/" if section.name && section.name.length > 0 + "/********** #{section.name} **********/\n" if section.name && section.name.length > 0 end def key_value_pattern - "\"%{key}\" = \"%{value}\";" + "\"%{key}\" = \"%{value}\";\n" end def format_comment(comment) From 3ebd9f35fd425a49e46e4c09249139cb820e1d28 Mon Sep 17 00:00:00 2001 From: Sebastian Ludwig Date: Mon, 24 Aug 2015 09:05:33 +0200 Subject: [PATCH 5/6] Completely migrated android formatter to modularized approach. --- lib/twine/formatters/abstract.rb | 9 +++-- lib/twine/formatters/android.rb | 64 +++++++++++++------------------- lib/twine/formatters/apple.rb | 2 +- 3 files changed, 32 insertions(+), 43 deletions(-) diff --git a/lib/twine/formatters/abstract.rb b/lib/twine/formatters/abstract.rb index 17a2115..818495f 100644 --- a/lib/twine/formatters/abstract.rb +++ b/lib/twine/formatters/abstract.rb @@ -149,6 +149,9 @@ module Twine 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 = "" @@ -157,7 +160,7 @@ module Twine result += comment + "\n" if comment end - result += key_value_pattern % { key: format_key(row.key), value: format_value(value) } + result += key_value_pattern % { key: format_key(row.key.dup), value: format_value(value.dup) } end def format_comment(comment) @@ -168,11 +171,11 @@ module Twine end def format_key(key) - raise NotImplementedError.new("You must implement format_key in your formatter class.") + key end def format_value(value) - raise NotImplementedError.new("You must implement format_value in your formatter class.") + value end def write_file(path, lang) diff --git a/lib/twine/formatters/android.rb b/lib/twine/formatters/android.rb index d300a28..c3cf504 100644 --- a/lib/twine/formatters/android.rb +++ b/lib/twine/formatters/android.rb @@ -95,45 +95,6 @@ module Twine "\n\n\n" end - def format_section_header(section) - "\t" - end - - def format_row(row, lang, default_lang) - result = "" - 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 - result += "\t\n" - end - result += "\t#{value}" - end - end - def format_sections(lang, default_lang) result = '' @@ -142,6 +103,31 @@ module Twine result += '' end + def format_section_header(section) + "\t" + end + + def format_comment(comment) + "\t" + end + + def key_value_pattern + "\t%{value}" + 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 diff --git a/lib/twine/formatters/apple.rb b/lib/twine/formatters/apple.rb index 9ff0b86..2bc63d0 100644 --- a/lib/twine/formatters/apple.rb +++ b/lib/twine/formatters/apple.rb @@ -87,7 +87,7 @@ module Twine end def format_section_header(section) - "/********** #{section.name} **********/\n" if section.name && section.name.length > 0 + "/********** #{section.name} **********/\n" end def key_value_pattern From 4a40e5d09e626c9d856e5893e45568281f27f187 Mon Sep 17 00:00:00 2001 From: Sebastian Ludwig Date: Mon, 24 Aug 2015 09:05:49 +0200 Subject: [PATCH 6/6] Modified documentation since options apply to all formats (once converted) now. --- lib/twine/cli.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/twine/cli.rb b/lib/twine/cli.rb index 4c642f0..48bd1a6 100644 --- a/lib/twine/cli.rb +++ b/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|