twine 0.1.0 → 0.1.1

data/README.md

@@ -8,16 +8,16 @@ Twine is a command line tool for managing your strings and their translations. T
 
 Twine is most easily installed as a Gem.
 
-	sudo gem install twine
+	$ gem install twine
 
 ### From Source
 
 You can also run Twine directly from source. However, it requires [rubyzip][rubyzip] in order to create and read standard zip files.
 
-	sudo gem install rubyzip
-	git clone git://github.com/mobiata/twine.git
-	cd twine
-	./twine --help
+	$ gem install rubyzip
+	$ git clone git://github.com/mobiata/twine.git
+	$ cd twine
+	$ ./twine --help
 
 Make sure you run the `twine` executable at the root of the project as it properly sets up your Ruby library path. The `bin/twine` executable does not.
 
@@ -78,42 +78,60 @@ Whitepace in this file is mostly ignored. If you absolutely need to put spaces a
 
 This command creates an Apple or Android strings file from the master strings data file.
 
-	> twine generate-string-file /path/to/strings.txt values-ja.xml --tag common,app1
-	> twine generate-string-file /path/to/strings.txt Localizable.strings --lang ja --tag mytag
-	> twine generate-string-file /path/to/strings.txt all-english.strings --lang en
+	$ twine generate-string-file /path/to/strings.txt values-ja.xml --tag common,app1
+	$ twine generate-string-file /path/to/strings.txt Localizable.strings --lang ja --tag mytag
+	$ twine generate-string-file /path/to/strings.txt all-english.strings --lang en
 
 #### `generate-all-string-files`
 
 This command is a convenient way to call `generate-string-file` multiple times. It uses standard Mac OS X, iOS, and Android conventions to figure out exactly which files to create given a parent directory. For example, if you point it to a parent directory containing `en.lproj`, `fr.lproj`, and `ja.lproj` subdirectories, Twine will create a `Localizable.strings` file of the appropriate language in each of them. This is often the command you will want to execute during the build phase of your project.
 
-	> twine generate-all-string-files /path/to/strings.txt /path/to/project/locales/directory --tag common,app1
+	$ twine generate-all-string-files /path/to/strings.txt /path/to/project/locales/directory --tag common,app1
 
 #### `consume-string-file`
 
 This command slurps all of the strings from a `.strings` or `.xml` file and incorporates the translated text into the master strings data file. This is a simple way to incorporate any changes made to a single file by one of your translators. It will only identify strings that already exist in the master data file.
 
-	> twine consume-string-file /path/to/strings.txt fr.strings
-	> twine consume-string-file /path/to/strings.txt Localizable.strings --lang ja
-	> twine consume-string-file /path/to/strings.txt es.xml
+	$ twine consume-string-file /path/to/strings.txt fr.strings
+	$ twine consume-string-file /path/to/strings.txt Localizable.strings --lang ja
+	$ twine consume-string-file /path/to/strings.txt es.xml
 
 #### `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.
 
-	> twine generate-loc-drop /path/to/strings.txt LocDrop1.zip
-	> twine generate-loc-drop /path/to/strings.txt LocDrop2.zip --lang en,fr,ja,ko --tag common,app1
+	$ twine generate-loc-drop /path/to/strings.txt LocDrop1.zip
+	$ twine generate-loc-drop /path/to/strings.txt LocDrop2.zip --lang en,fr,ja,ko --tag common,app1
 
 #### `consume-loc-drop`
 
 This command is a convenient way of taking a zip file and executing the `consume-string-file` command on each file within the archive. It is most often used to incorporate all of the changes made by the translation team after they have completed work on a localization drop.
 
-	> twine consume-loc-drop /path/to/strings.txt LocDrop2.zip
+	$ twine consume-loc-drop /path/to/strings.txt LocDrop2.zip
 
 #### `generate-report`
 
 This command gives you useful information about your strings. It will tell you how many strings you have, how many have been translated into each language, and whether your master strings data file has any duplicate string keys.
 
-	> twine generate-report /path/to/strings.txt
+	$ twine generate-report /path/to/strings.txt
+
+## Twine in your Build Process
+
+It is easy to incorporate Twine right into your iOS and Mac 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
+
+	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.
+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.
 
 [rubyzip]: http://rubygems.org/gems/rubyzip
 [git]: http://git-scm.org/

data/lib/twine/formatters/android.rb

@@ -53,18 +53,20 @@ module Twine
         default_lang = strings.language_codes[0]
         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 '<resources>'
-          section_num = -1
+          f.write '<resources>'
           strings.sections.each do |section|
-            section_num += 1
-            if section_num > 0
-              f.puts ''
-            end
-
-            section_name = section.name.gsub('--', '—')
-            f.puts "\t<!-- #{section_name} -->"
+            printed_section = false
             section.rows.each do |row|
               if row_matches_tags?(row, tags)
+                unless printed_section
+                  f.puts ''
+                  if section.name && section.name.length > 0
+                    section_name = section.name.gsub('--', '—')
+                    f.puts "\t<!-- #{section_name} -->"
+                  end
+                  printed_section = true
+                end
+
                 key = row.key
                 key = CGI.escapeHTML(key)
 

data/lib/twine/formatters/apple.rb

@@ -26,7 +26,7 @@ module Twine
       end
 
       def read_file(path, lang, strings)
-        File.open(path, 'r:UTF-16') do |f|
+        File.open(path, 'r:UTF-8') do |f|
           while line = f.gets
             match = /"((?:[^"\\]|\\.)+)"\s*=\s*"((?:[^"\\]|\\.)*)/.match(line)
             if match
@@ -46,12 +46,20 @@ module Twine
 
       def write_file(path, lang, tags, strings)
         default_lang = strings.language_codes[0]
-        File.open(path, 'w:UTF-16') do |f|
+        File.open(path, 'w:UTF-8') do |f|
           f.puts "/**\n * iOS Strings File\n * Generated by Twine\n * Language: #{lang}\n */"
           strings.sections.each do |section|
-            f.puts "\n/* #{section.name} */"
+            printed_section = false
             section.rows.each do |row|
               if row_matches_tags?(row, tags)
+                unless printed_section
+                  f.puts ''
+                  if section.name && section.name.length > 0
+                    f.puts "/* #{section.name} */"
+                  end
+                  printed_section = true
+                end
+
                 key = row.key
                 key = key.gsub('"', '\\\\"')
 

data/lib/twine/version.rb

@@ -1,3 +1,3 @@
 module Twine
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twine
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-06 00:00:00.000000000 Z
+date: 2012-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
-  requirement: &70351938160380 !ruby/object:Gem::Requirement
+  requirement: &70309529145320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,7 @@ dependencies:
         version: 0.9.5
   type: :runtime
   prerelease: false
-  version_requirements: *70351938160380
+  version_requirements: *70309529145320
 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