twine 0.1.2 → 0.2.0

data/bin/twine

@@ -4,5 +4,5 @@ begin
   Twine::Runner.run(ARGV)
 rescue Twine::Error => e
   STDERR.puts e.message
-  abort
+  exit
 end

data/lib/twine.rb

@@ -3,6 +3,7 @@ module Twine
   end
   
   require 'twine/cli'
+  require 'twine/encoding'
   require 'twine/formatters'
   require 'twine/runner'
   require 'twine/stringsfile'

data/lib/twine/cli.rb

@@ -25,7 +25,7 @@ module Twine
         opts.separator ''
         opts.separator 'consume-string-file -- Slurps all of the strings from a translated strings file into the specified STRINGS_FILE. If you have some files returned to you by your translators you can use this command to incorporate all of their changes. This script will attempt to guess both the language and the format given the filename and extension. For example, "ja.strings" will assume that the file is a Japanese iOS strings file.'
         opts.separator ''
-        opts.separator 'generate-loc-drop -- Generates a zip archive of strings files in any format. The purpose of this command is to create a very simple archive that can be handed off to a translation team. The translation team can unzip the archive, translate all of the strings in the archived files, zip everything back up, and then hand that final archive back to be consumed by the consume-loc-drop command.'
+        opts.separator 'generate-loc-drop -- Generates a zip archive of strings files in any format. The purpose of this command is to create a very simple archive that can be handed off to a translation team. The translation team can unzip the archive, translate all of the strings in the archived files, zip everything back up, and then hand that final archive back to be consumed by the consume-loc-drop command. This command assumes that --all has been specified on the command line.'
         opts.separator ''
         opts.separator 'consume-loc-drop -- Consumes an archive of translated files. This archive should be in the same format as the one created by the generate-loc-drop command.'
         opts.separator ''
@@ -53,8 +53,14 @@ module Twine
           end
           @options[:format] = lformat
         end
-        opts.on('-a', '--all', 'Normally, when consuming a string file, Twine will ignore any string keys that do not exist in your master file. This flag will force those missing strings to be added to your master file.') do |a|
-          @options[:consume_all] = true
+        opts.on('-a', '--all', 'Normally, when consuming a string file, Twine will ignore any string keys that do not exist in your master file. This flag will also cause any Android string files that are generated to include strings that have not yet been translated for the current language.') do |a|
+          @options[:consume_generate_all] = true
+        end
+        opts.on('-e', '--encoding ENCODING', 'Twine defaults to encoding all output files in UTF-8. This flag will tell Twine to use an alternate encoding for these files. For example, you could use this to write Apple .strings files in UTF-16. This flag currently only works with Apple .strings files and is currently only supported in Ruby 1.9.3 or greater.') do |e|
+          if !"".respond_to?(:encode)
+            raise Twine::Error.new "The --encoding flag is only supported on Ruby 1.9.3 or greater."
+          end
+          @options[:output_encoding] = e
         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|
           @options[:output_path] = o
@@ -128,6 +134,7 @@ module Twine
           raise Twine::Error.new 'Please only specify a single language for the consume-string-file command.'
         end
       when 'generate-loc-drop'
+        @options[:consume_generate_all] = true
         if @args.length == 3
           @options[:output_path] = @args[2]
         elsif @args.length > 3

data/lib/twine/encoding.rb

@@ -0,0 +1,20 @@
+module Twine
+  module Encoding
+    def self.encoding_for_path path
+      File.open(path, 'rb') do |f|
+        begin
+          a = f.readbyte
+          b = f.readbyte
+          if (a == 0xfe && b == 0xff)
+            return 'UTF-16BE'
+          elsif (a == 0xff && b == 0xfe)
+            return 'UTF-16LE'
+          end
+        rescue EOFError
+        end
+      end
+
+      'UTF-8'
+    end
+  end
+end

data/lib/twine/formatters/abstract.rb

@@ -16,7 +16,7 @@ module Twine
       def set_translation_for_key(key, lang, value)
         if @strings.strings_map.include?(key)
           @strings.strings_map[key].translations[lang] = value
-        elsif @options[:consume_all]
+        elsif @options[:consume_generate_all]
           STDERR.puts "Adding new string '#{key}' to strings data file."
           arr = @strings.sections.select { |s| s.name == 'Uncategorized' }
           current_section = arr ? arr[0] : nil

data/lib/twine/formatters/android.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 
-require 'cgi'
 require 'rexml/document'
 
 module Twine
@@ -9,9 +8,21 @@ module Twine
       FORMAT_NAME = 'android'
       EXTENSION = '.xml'
       DEFAULT_FILE_NAME = 'strings.xml'
+      LANG_CODES = Hash[
+        'zh' => 'zh-Hans',
+        'zh-rCN' => 'zh-Hans',
+        'zh-rHK' => 'zh-Hant',
+        'en-rGB' => 'en-UK',
+        'in' => 'id',
+        '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) }
+        Dir.entries(path).any? { |item| /^values.*$/.match(item) }
       end
 
       def default_file_name
@@ -21,11 +32,16 @@ module Twine
       def determine_language_given_path(path)
         path_arr = path.split(File::SEPARATOR)
         path_arr.each do |segment|
-          match = /^values-(.*)$/.match(segment)
-          if match
-            lang = match[1]
-            lang.sub!('-r', '-')
-            return lang
+          if segment == 'values'
+            return @strings.language_codes[0]
+          else
+            match = /^values-(.*)$/.match(segment)
+            if match
+              lang = match[1]
+              lang = LANG_CODES.fetch(lang, lang)
+              lang.sub!('-r', '-')
+              return lang
+            end
           end
         end
 
@@ -40,22 +56,28 @@ module Twine
             key = ele.attributes["name"]
             value = ele.text || ''
             value.gsub!('\\\'', '\'')
+            value.gsub!('\\"', '"')
             value.gsub!(/\n/, '')
-            value.gsub!('%s', '%@')
+            value.gsub!(/%([0-9\$]*)s/, '%\1@')
+            value.gsub!('&lt;', '<')
+            value.gsub!('&amp;', '&')
             set_translation_for_key(key, lang, value)
           end
         end
       end
 
       def write_file(path, lang)
-        default_lang = @strings.language_codes[0]
+        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 -->\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])
+              if row.matches_tags?(@options[:tags])
                 if !printed_section
                   f.puts ''
                   if section.name && section.name.length > 0
@@ -66,22 +88,35 @@ module Twine
                 end
 
                 key = row.key
-                key = CGI.escapeHTML(key)
 
                 value = row.translated_string_for_lang(lang, default_lang)
-                value.gsub!('\'', '\\\\\'')
-                value.gsub!('%@', '%s')
-                value = CGI.escapeHTML(value)
-
-                comment = row.comment
-                if comment
-                  comment = comment.gsub('--', '—')
+                if !value && @options[:consume_generate_all]
+                  value = row.translated_string_for_lang(@strings.language_codes[0])
                 end
 
-                if comment && comment.length > 0
-                  f.puts "\t<!-- #{comment} -->\n"
+                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) ampersand and less-than must be in XML-escaped form
+                  value.gsub!('&', '&amp;')
+                  value.gsub!('<', '&lt;')
+                  #  3) use "s" instead of "@" for substituting strings
+                  value.gsub!(/%([0-9\$]*)@/, '%\1s')
+  
+                  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
-                f.puts "\t<string name=\"#{key}\">#{value}</string>"
               end
             end
           end

data/lib/twine/formatters/apple.rb

@@ -26,8 +26,35 @@ module Twine
       end
 
       def read_file(path, lang)
-        File.open(path, 'r:UTF-8') do |f|
-          while line = f.gets
+        encoding = Twine::Encoding.encoding_for_path(path)
+        sep = nil
+        if !encoding.respond_to?(:encode)
+          # This code is not necessary in 1.9.3 and does not work as it did in 1.8.7.
+          if encoding.end_with? 'LE'
+            sep = "\x0a\x00"
+          elsif encoding.end_with? 'BE'
+            sep = "\x00\x0a"
+          else
+            sep = "\n"
+          end
+        end
+
+        if encoding.index('UTF-16')
+          mode = "rb:#{encoding}"
+        else
+          mode = "r:#{encoding}"
+        end
+
+        File.open(path, mode) do |f|
+          while line = (sep) ? f.gets(sep) : f.gets
+            if encoding.index('UTF-16')
+              if line.respond_to? :encode!
+                line.encode!('UTF-8')
+              else
+                require 'iconv'
+                line = Iconv.iconv('UTF-8', encoding, line).join
+              end
+            end
             match = /"((?:[^"\\]|\\.)+)"\s*=\s*"((?:[^"\\]|\\.)*)"/.match(line)
             if match
               key = match[1]
@@ -42,12 +69,13 @@ module Twine
 
       def write_file(path, lang)
         default_lang = @strings.language_codes[0]
-        File.open(path, 'w:UTF-8') do |f|
+        encoding = @options[:output_encoding] || 'UTF-8'
+        File.open(path, "w:#{encoding}") do |f|
           f.puts "/**\n * iOS Strings File\n * Generated by Twine\n * Language: #{lang}\n */"
           @strings.sections.each do |section|
             printed_section = false
             section.rows.each do |row|
-              if row.matches_tags?(options[:tags])
+              if row.matches_tags?(@options[:tags])
                 if !printed_section
                   f.puts ''
                   if section.name && section.name.length > 0

data/lib/twine/runner.rb

@@ -137,7 +137,7 @@ module Twine
               file_name = lang + formatter.class::EXTENSION
               real_path = File.join(dir, file_name)
               zip_path = File.join('Locales', file_name)
-              formatter.write_file(real_path, lang, @options[:tags], @strings)
+              formatter.write_file(real_path, lang)
               zipfile.add(zip_path, real_path)
             end
           end

data/lib/twine/stringsfile.rb

@@ -41,7 +41,18 @@ module Twine
     end
     
     def translated_string_for_lang(lang, default_lang=nil)
-      @translations[lang] || @translations[default_lang]
+      if @translations[lang]
+        return @translations[lang]
+      elsif default_lang.respond_to?("each")
+        default_lang.each do |def_lang|
+          if @translations[def_lang]
+            return @translations[def_lang]
+          end
+        end
+        return nil
+      else
+        return @translations[default_lang]
+      end
     end
   end
 
@@ -94,7 +105,7 @@ module Twine
               parsed = true
             end
           else
-            match = /^([^=]+)=(.+)$/.match(line)
+            match = /^([^=]+)=(.*)$/.match(line)
             if match
               key = match[1].strip
               value = match[2].strip

data/lib/twine/version.rb

@@ -1,3 +1,3 @@
 module Twine
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/test/twine_test.rb

@@ -5,7 +5,7 @@ class TwineTest < Test::Unit::TestCase
   def test_generate_string_file_1
     Dir.mktmpdir do |dir|
       output_path = File.join(dir, 'fr.xml')
-      Twine::Runner.run(%W(generate-string-file test/fixtures/strings-1.txt #{output_path}))
+      Twine::Runner.run(%W(generate-string-file test/fixtures/strings-1.txt #{output_path} --all))
       assert_equal(File.read('test/fixtures/test-output-1.txt'), File.read(output_path))
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twine
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-11 00:00:00.000000000 Z
+date: 2012-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
-  requirement: &70180596581660 !ruby/object:Gem::Requirement
+  requirement: &70216088301260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.9.5
   type: :runtime
   prerelease: false
-  version_requirements: *70180596581660
+  version_requirements: *70216088301260
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70180596581180 !ruby/object:Gem::Requirement
+  requirement: &70216088300680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70180596581180
+  version_requirements: *70216088300680
 description: ! "  Twine is a command line tool for managing your strings and their
   translations.\n  \n  It is geared toward Mac OS X, iOS, and Android developers.\n"
 email: twine@mobiata.com
@@ -45,6 +45,7 @@ files:
 - README.md
 - LICENSE
 - lib/twine/cli.rb
+- lib/twine/encoding.rb
 - lib/twine/formatters/abstract.rb
 - lib/twine/formatters/android.rb
 - lib/twine/formatters/apple.rb