twine 0.2.1 → 0.2.2

data/README.md

@@ -47,7 +47,7 @@ Whitepace in this file is mostly ignored. If you absolutely need to put spaces a
 			en = No
 			fr = Non
 			ja = いいえ
-			
+	
 	[[Errors]]
 		[path_not_found_error]
 			en = The file '%@' could not be found.
@@ -57,7 +57,7 @@ Whitepace in this file is mostly ignored. If you absolutely need to put spaces a
 			en = The network is currently unavailable.
 			tags = app1
 			comment = An error describing when the device can not connect to the internet.
-			
+	
 	[[Escaping Example]]
 		[list_item_separator]
 			en = `, `
@@ -96,6 +96,12 @@ This command slurps all of the strings from a `.strings` or `.xml` file and inco
 	$ twine consume-string-file /path/to/strings.txt Localizable.strings --lang ja
 	$ twine consume-string-file /path/to/strings.txt es.xml
 
+#### `consume-all-string-files`
+
+This command reads in a folder containing many `.strings` or `.xml` files. These files should be in a standard folder hierarchy so that twine knows the language of each file. When combined with the `--developer-language`, `--consume-comments`, and `--consume-all` flags, this command is a great way to create your initial strings data file from an existing iOS or Android project. Just make sure that you create a blank strings.txt file, first!
+
+	$ twine consume-all-string-files strings.txt Resources/Locales --developer-language en --consume-all --consume-comments
+
 #### `generate-loc-drop`
 
 This command is a convenient way to generate a zip file containing files created by the `generate-string-file` command. It is often used for creating a single zip containing a large number of strings in all languages which you can then hand off to your translation team.
@@ -115,23 +121,30 @@ This command gives you useful information about your strings. It will tell you h
 
 	$ twine generate-report /path/to/strings.txt
 
-## Twine in your Build Process
+## Creating Your First strings.txt File
+
+The easiest way to create your first strings.txt file is to run the `consume-all-string-files` command. The one caveat is to first create a blank strings.txt file to use as your starting point. Then, just point the `consume-all-string-files` command at a directory in your project containing all of your iOS, OS X, or Android strings files.
+
+	$ touch strings.txt
+	$ twine consume-all-string-files strings.txt Resources/Locales --developer-language en --consume-all --consume-comments
+
+## Twine and Your Build Process
 
-It is easy to incorporate Twine right into your iOS and Mac OS X app build processes.
+It is easy to incorporate Twine right into your iOS and OS X app build processes.
 
 1. In your project folder, create all of the `.lproj` directories that you need. It does not really matter where they are. We tend to put them in `Resources/Locales/`.
 2. Run the `generate-all-string-files` command to create all of the string files you need in these directories. For example,
 
-	$ twine generate-all-string-files strings.txt Resources/Locales/ --tags tag1,tag2
+		$ twine generate-all-string-files strings.txt Resources/Locales/ --tags tag1,tag2
 
-	Make sure you point Twine at your strings data file, the directory that contains all of your `.lproj` directories, and and the tags that describe the strings you want to use for this project.
+	Make sure you point Twine at your strings data file, the directory that contains all of your `.lproj` directories, and the tags that describe the strings you want to use for this project.
 3. Drag the `Resources/Locales/` directory to the Xcode project navigator so that Xcode knows to include all of these strings files in your build.
 4. In Xcode, navigate to the "Build Phases" tab of your target.
 5. Click on the "Add Build Phase" button and select "Add Run Script".
 6. Drag the new "Run Script" build phase up so that it runs earlier in the build process. It doesn't really matter where, as long as it happens before the resources are copied to your bundle.
 7. Edit your script to run the exact same command you ran in step (2) above.
 
-Now, whenever you build your application, Xcode will automatically invoke Twine to make sure that your `.strings` files are always up-to-date.
+Now, whenever you build your application, Xcode will automatically invoke Twine to make sure that your `.strings` files are up-to-date.
 
 [rubyzip]: http://rubygems.org/gems/rubyzip
 [git]: http://git-scm.org/

data/lib/twine/cli.rb

@@ -19,12 +19,14 @@ module Twine
         opts.separator ''
         opts.separator 'Commands:'
         opts.separator ''
-        opts.separator 'generate-strings-file -- Generates a string file in a certain LANGUAGE given a particular FORMAT. This script will attempt to guess both the language and the format given the filename and extension. For example, "ko.xml" will generate a Korean language file for Android.'
+        opts.separator 'generate-string-file -- Generates a string file in a certain LANGUAGE given a particular FORMAT. This script will attempt to guess both the language and the format given the filename and extension. For example, "ko.xml" will generate a Korean language file for Android.'
         opts.separator ''
         opts.separator 'generate-all-string-files -- Generates all the string files necessary for a given project. The parent directory to all of the locale-specific directories in your project should be specified as the INPUT_OR_OUTPUT_PATH. This command will most often be executed by your build script so that each build always contains the most recent strings.'
         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 'consume-all-string-files -- Slurps all of the strings from a directory 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. This command assumes that --include-untranslated 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.'
@@ -62,6 +64,12 @@ module Twine
         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
         end
+        opts.on('-d', '--developer-language LANG', 'When writing the strings data file, set the specified language as the "developer language". In practice, this just means that this language will appear first in the strings data file.') do |d|
+          @options[:developer_language] = d
+        end
+        opts.on('-c', '--consume-comments', 'Normally, when consuming a string file, Twine will ignore all comments in the file. With this flag set, any comments encountered will be read and parsed into the strings data file. This is especially useful when creating your first strings data file from an existing project.') do |c|
+          @options[:consume_comments] = 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."
@@ -82,6 +90,7 @@ module Twine
         opts.separator '> twine generate-string-file strings.txt ko.xml --tags FT'
         opts.separator '> twine generate-all-string-files strings.txt Resources/Locales/ --tags FT,FB'
         opts.separator '> twine consume-string-file strings.txt ja.strings'
+        opts.separator '> twine consume-all-string-files strings.txt Resources/Locales/ --developer-language en'
         opts.separator '> twine generate-loc-drop strings.txt LocDrop5.zip --tags FT,FB --format android --lang de,en,en-GB,ja,ko'
         opts.separator '> twine consume-loc-drop strings.txt LocDrop5.zip'
         opts.separator '> twine generate-report strings.txt'
@@ -136,6 +145,14 @@ module Twine
         if @options[:languages] and @options[:languages].length > 1
           raise Twine::Error.new 'Please only specify a single language for the consume-string-file command.'
         end
+      when 'consume-all-string-files'
+        if @args.length == 3
+          @options[:input_path] = @args[2]
+        elsif @args.length > 3
+          raise Twine::Error.new "Unknown argument: #{@args[3]}"
+        else
+          raise Twine::Error.new 'Not enough arguments.'
+        end
       when 'generate-loc-drop'
         @options[:include_untranslated] = true
         if @args.length == 3

data/lib/twine/formatters/abstract.rb

@@ -36,6 +36,12 @@ module Twine
         end
       end
 
+      def set_comment_for_key(key, comment)
+        if @strings.strings_map.include?(key)
+          @strings.strings_map[key].comment = comment
+        end
+      end
+
       def default_file_name
         raise NotImplementedError.new("You must implement default_file_name in your formatter class.")
       end

data/lib/twine/formatters/android.rb

@@ -58,9 +58,9 @@ module Twine
             value.gsub!('\\\'', '\'')
             value.gsub!('\\"', '"')
             value.gsub!(/\n/, '')
-            value.gsub!(/%([0-9\$]*)s/, '%\1@')
             value.gsub!('&lt;', '<')
             value.gsub!('&amp;', '&')
+            value = iosify_substitutions(value)
             set_translation_for_key(key, lang, value)
           end
         end
@@ -72,7 +72,7 @@ module Twine
           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.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
@@ -96,7 +96,7 @@ module Twine
 
                 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!('\'', '\\\\\'')
@@ -104,14 +104,14 @@ module Twine
                   #  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')
-  
+                  #  3) fix substitutions (e.g. %s/%@)
+                  value = androidify_substitutions(value)
+
                   comment = row.comment
                   if comment
                     comment = comment.gsub('--', '—')
                   end
-  
+
                   if comment && comment.length > 0
                     f.puts "\t<!-- #{comment} -->\n"
                   end
@@ -124,6 +124,92 @@ module Twine
           f.puts '</resources>'
         end
       end
+
+      def iosify_substitutions(str)
+        # 1) use "@" instead of "s" for substituting strings
+        str.gsub!(/%([0-9\$]*)s/, '%\1@')
+
+        # 2) if substitutions are numbered, see if we can remove the numbering safely
+        expectedSub = 1
+        startFound = false
+        foundSub = 0
+        str.each_char do |c|
+          if startFound
+            if c == "%"
+              # this is a literal %, keep moving
+              startFound = false
+            elsif c.match(/\d/)
+              foundSub *= 10
+              foundSub += Integer(c)
+            elsif c == "$"
+              if expectedSub == foundSub
+                # okay to keep going
+                startFound = false
+                expectedSub += 1
+              else
+                # the numbering appears to be important (or non-existent), leave it alone
+                return str
+              end
+            end
+          elsif c == "%"
+            startFound = true
+            foundSub = 0
+          end
+        end
+
+        # if we got this far, then the numbering (if any) is in order left-to-right and safe to remove
+        if expectedSub > 1
+          str.gsub!(/%\d+\$(.)/, '%\1')
+        end
+
+        return str
+      end
+
+      def androidify_substitutions(str)
+        # 1) use "s" instead of "@" for substituting strings
+        str.gsub!(/%([0-9\$]*)@/, '%\1s')
+
+        # 2) if there is more than one substitution in a string, make sure they are numbered
+        substituteCount = 0
+        startFound = false
+        str.each_char do |c|
+          if startFound
+            if c == "%"
+              # ignore as this is a literal %
+            elsif c.match(/\d/)
+              # leave the string alone if it already has numbered substitutions
+              return str
+            else
+              substituteCount += 1
+            end
+            startFound = false
+          elsif c == "%"
+            startFound = true
+          end
+        end
+
+        if substituteCount > 1
+          currentSub = 1
+          startFound = false
+          newstr = ""
+          str.each_char do |c|
+            if startFound
+              if !(c == "%")
+                newstr = newstr + "#{currentSub}$"
+                currentSub += 1
+              end
+              startFound = false
+            elsif c == "%"
+              startFound = true
+            end
+            newstr = newstr + c
+          end
+          return newstr
+        else
+          return str
+        end
+      end
+
     end
   end
 end

data/lib/twine/formatters/apple.rb

@@ -46,6 +46,7 @@ module Twine
         end
 
         File.open(path, mode) do |f|
+          last_comment = nil
           while line = (sep) ? f.gets(sep) : f.gets
             if encoding.index('UTF-16')
               if line.respond_to? :encode!
@@ -62,6 +63,17 @@ module Twine
               value = match[2]
               value.gsub!('\\"', '"')
               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
             end
           end
         end
@@ -71,15 +83,15 @@ module Twine
         default_lang = @strings.language_codes[0]
         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 */"
+          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
-                  f.puts ''
                   if section.name && section.name.length > 0
-                    f.puts "/* #{section.name} */"
+                    f.print "/********** #{section.name} **********/\n\n"
                   end
                   printed_section = true
                 end
@@ -95,13 +107,12 @@ module Twine
                   comment = comment.gsub('*/', '* /')
                 end
 
-                f.print "\"#{key}\" = \"#{value}\";"
                 if comment && comment.length > 0
-                  f.print "  /* #{comment} */\n"
-                else
-                  f.print "\n"
+                  f.print "/* #{comment} */\n"
                 end
-              end
+
+                f.print "\"#{key}\" = \"#{value}\";\n"
+             end
             end
           end
         end

data/lib/twine/runner.rb

@@ -1,7 +1,7 @@
 require 'tmpdir'
 
 module Twine
-  VALID_COMMANDS = ['generate-string-file', 'generate-all-string-files', 'consume-string-file', 'generate-loc-drop', 'consume-loc-drop', 'generate-report']
+  VALID_COMMANDS = ['generate-string-file', 'generate-all-string-files', 'consume-string-file', 'consume-all-string-files', 'generate-loc-drop', 'consume-loc-drop', 'generate-report']
 
   class Runner
     def initialize(args)
@@ -25,6 +25,13 @@ module Twine
       @strings.read @options[:strings_file]
     end
 
+    def write_strings_data(path)
+      if @options[:developer_language]
+        @strings.set_developer_language_code(@options[:developer_language])
+      end
+      @strings.write(path)
+    end
+
     def execute_command
       case @options[:command]
       when 'generate-string-file'
@@ -33,6 +40,8 @@ module Twine
         generate_all_string_files
       when 'consume-string-file'
         consume_string_file
+      when 'consume-all-string-files'
+        consume_all_string_files
       when 'generate-loc-drop'
         generate_loc_drop
       when 'consume-loc-drop'
@@ -55,7 +64,7 @@ module Twine
       if !File.directory?(@options[:output_path])
         raise Twine::Error.new("Directory does not exist: #{@options[:output_path]}")
       end
-      
+
       format = @options[:format]
       if !format
         format = determine_format_given_directory(@options[:output_path])
@@ -77,7 +86,26 @@ module Twine
 
       read_write_string_file(@options[:input_path], true, lang)
       output_path = @options[:output_path] || @options[:strings_file]
-      @strings.write(output_path)
+      write_strings_data(output_path)
+    end
+
+    def consume_all_string_files
+      if !File.directory?(@options[:input_path])
+        raise Twine::Error.new("Directory does not exist: #{@options[:output_path]}")
+      end
+
+      Dir.glob(File.join(@options[:input_path], "**/*")) do |item|
+        if File.file?(item)
+          begin
+            read_write_string_file(item, true, nil)
+          rescue Twine::Error => e
+            STDERR.puts "#{e.message}"
+          end
+        end
+      end
+
+      output_path = @options[:output_path] || @options[:strings_file]
+      write_strings_data(output_path)
     end
 
     def read_write_string_file(path, is_read, lang)
@@ -159,18 +187,22 @@ module Twine
       Dir.mktmpdir do |dir|
         Zip::ZipFile.open(@options[:input_path]) do |zipfile|
           zipfile.each do |entry|
-            if !entry.name.end_with?'/'
+            if !entry.name.end_with?'/' and !File.basename(entry.name).start_with?'.'
               real_path = File.join(dir, entry.name)
               FileUtils.mkdir_p(File.dirname(real_path))
               zipfile.extract(entry.name, real_path)
-              read_write_string_file(real_path, true, nil)
+              begin
+                read_write_string_file(real_path, true, nil)
+              rescue Twine::Error => e
+                STDERR.puts "#{e.message}"
+              end
             end
           end
         end
       end
 
       output_path = @options[:output_path] || @options[:strings_file]
-      @strings.write(output_path)
+      write_strings_data(output_path)
     end
 
     def generate_report

data/lib/twine/stringsfile.rb

@@ -21,7 +21,7 @@ module Twine
       @tags = nil
       @translations = {}
     end
-    
+
     def matches_tags?(tags, include_untagged)
       if tags == nil || tags.length == 0
         # The user did not specify any tags. Everything passes.
@@ -39,7 +39,7 @@ module Twine
 
       return false
     end
-    
+
     def translated_string_for_lang(lang, default_lang=nil)
       if @translations[lang]
         return @translations[lang]
@@ -190,5 +190,12 @@ module Twine
         @language_codes.insert(0, dev_lang)
       end
     end
+
+    def set_developer_language_code(code)
+      if @language_codes.include?(code)
+        @language_codes.delete(code)
+      end
+      @language_codes.insert(0, code)
+    end
   end
 end

data/lib/twine/version.rb

@@ -1,3 +1,3 @@
 module Twine
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/lib/twine.rb

@@ -1,7 +1,7 @@
 module Twine
   class Error < StandardError
   end
-  
+
   require 'twine/cli'
   require 'twine/encoding'
   require 'twine/formatters'

data/test/fixtures/test-output-1.txt

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- Android Strings File -->
-<!-- Generated by Twine -->
+<!-- Generated by Twine <%= Twine::VERSION %> -->
 <!-- Language: fr -->
 <resources>
 	<!-- My Strings -->

data/test/fixtures/test-output-2.txt

@@ -1,9 +1,11 @@
 /**
- * iOS Strings File
- * Generated by Twine
+ * Apple Strings File
+ * Generated by Twine <%= Twine::VERSION %>
  * Language: en
  */
 
-/* My Strings */
+/********** My Strings **********/
+
 "key1" = "key1-english";
+
 "key3" = "key3-english";

data/test/twine_test.rb

@@ -1,3 +1,4 @@
+require 'ERB'
 require 'test/unit'
 require 'twine'
 
@@ -6,7 +7,7 @@ class TwineTest < Test::Unit::TestCase
     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} --include-untranslated))
-      assert_equal(File.read('test/fixtures/test-output-1.txt'), File.read(output_path))
+      assert_equal(ERB.new(File.read('test/fixtures/test-output-1.txt')).result, File.read(output_path))
     end
   end
 
@@ -14,7 +15,7 @@ class TwineTest < Test::Unit::TestCase
     Dir.mktmpdir do |dir|
       output_path = File.join(dir, 'en.strings')
       Twine::Runner.run(%W(generate-string-file test/fixtures/strings-1.txt #{output_path} -t tag1))
-      assert_equal(File.read('test/fixtures/test-output-2.txt'), File.read(output_path))
+      assert_equal(ERB.new(File.read('test/fixtures/test-output-2.txt')).result, File.read(output_path))
     end
   end
 
@@ -33,7 +34,7 @@ class TwineTest < Test::Unit::TestCase
       assert_equal(File.read('test/fixtures/test-output-4.txt'), File.read(output_path))
     end
   end
-  
+
   def test_generate_report_1
     Twine::Runner.run(%w(generate-report test/fixtures/strings-1.txt))
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twine
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-02 00:00:00.000000000 Z
+date: 2012-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
-  requirement: &70104222129900 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: 0.9.5
   type: :runtime
   prerelease: false
-  version_requirements: *70104222129900
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.5
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70104222128800 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +37,12 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70104222128800
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
 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
@@ -83,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.18
 signing_key: 
 specification_version: 3
 summary: Manage strings and their translations for your iOS and Android projects.