vocab 0.0.2 → 0.0.3

data/.gitignore

@@ -2,8 +2,9 @@
 *.tmp
 .bundle
 Gemfile.lock
+coverage/*
 pkg/*
 spec/tmp/*
 !spec/tmp/.vocab
 spec/data/android/versions/*.tmp
-tmp/last_translation/*
+tmp/last_translation/*

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# 0.0.3
+
+  * Support multiple pending translations by changing .vocab in extract command
+  * Escape apostrophe "'" characters in android string xml files for make android resource loader not crash

data/MIT-LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Inquisitive Minds, Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -2,7 +2,7 @@
 
 Command line tool to automate the manipulation of i18n string files in Rails and Android.
 
-Features include:
+## Features include:
 
   * Generate a list all English translations that have been updated or added since the last translation
   * Integrate a list of newly translated strings into the right place in the project translation file(s)
@@ -11,7 +11,7 @@ Features include:
 # Requirements
 
   * Must be used in context of git controlled project
-  * Assumes that android string files are called strings.xml
+  * Assumes that android string files are called strings.xml under res/values-xx
 
 # Installation
 
@@ -23,36 +23,88 @@ Set the current git commit to be the starting point for the next translation dif
 
     vocab init
 
+You may need to change the SHA hash in .vocab to match the commit of the last translation
+
 # Usage
 
-## Extracting Changed and Updated Strings For Translation
+## Android
+
+### Extract Changed and Updated Strings For Translation
 
+    cd APP_ROOT
     vocab extract android
 
-    or
+This will create two files in the current directory:
 
-    vocab extract rails
+`strings.diff.xml` Contains all the keys that need to be updated for existing languages
+`strings.full.xml` Contains all keys for a full translation
 
-Note: keys starting with 'debug_' are ignored.  Prepend development-only strings
-with 'debug_' to avoid these keys being sent to translators.
+Send these files off to the appropriate translator.  When they files come back,
+put the partial language translations in `tmp/translations`.  For example:
 
-## Merging new translations into project string files
+    tmp/translations/values-zn/strings.xml
+    tmp/translations/values-es/es-strings-7.xml
 
-    vocab merge android
+The file must be in the properly named folder and end with xml.
 
-    or
+For new language files, just put them directly under the `res` directory.
 
-    vocab merge rails
+### Merging new translations into project string files
 
-## Merging new translations into project string files
+Integrate the translations with the following command:
 
+    cd APP_ROOT
+    vocab merge android
+
+### Validating that all translations have the same keys
+
+    cd APP_ROOT
     vocab validate android
 
-    or
+## Rails
+
+### Extract Changed and Updated Strings For Translation
+
+    cd RAILS_ROOT
+    vocab extract rails
+
+This will create two files in the current directory:
 
+`en.diff.yml` Contains all the keys that need to be updated for existing languages
+`en.full.yml` Contains all keys for a full translation
+
+Send these files off to the appropriate translator.  When they files come back,
+put them in `tmp/translations`.  For example:
+
+    tmp/translations/zn.yml
+    tmp/translations/es.yml
+
+### Merging new translations into project string files
+
+Integrate the translations with the following command:
+
+    cd RAILS_ROOT
+    vocab merge rails
+
+ Keys will be put in the correct nested yml file.  You can put whole or partial translations
+ in tmp/translations.
+
+### Validating that all translations have the same keys
+
+    cd RAILS_ROOT
     vocab validate rails
 
+# Other details
+
+Keys starting with 'debug_' are ignored for both Rails and Android string files.  Prepend development-only strings
+with 'debug_' to avoid these keys being sent to translators.
+
 # TODO
 
   * Add .processed to each tmp/translation after success
-  * Accept filenames other than strings.xml under tmp/translation/values-xx/yyyy.xml
+  * Handle full translations under tmp/translations when no existing translation exists in android
+  * Add iOS support
+  * Add AIR support
+  * Add Chrome support
+  * Add Firefox support
+  

data/bin/vocab

@@ -8,4 +8,4 @@ end
 
 require 'vocab'
 
-Vocab::Application.run
+exit Vocab::Application.run

data/lib/vocab/application.rb

@@ -3,10 +3,10 @@ require 'ostruct'
 
 module Vocab
   class Application
-
+    
     class << self
       def run
-        handle_command
+        return handle_command
       end
 
       ##############################
@@ -14,6 +14,7 @@ module Vocab
       ##############################
 
       def handle_command
+        success = true
         options = OpenStruct.new
         parser = OptionParser.new
 
@@ -45,14 +46,15 @@ module Vocab
         elsif( options.command == 'merge' && options.platform == 'android' )
           Merger::Android.new.merge
         elsif( options.command == 'validate' && options.platform == 'android' )
-          Validator::Android.new.validate
+          success = Validator::Android.new.validate
         elsif( options.command == 'validate' && options.platform == 'rails' )
-          Validator::Rails.new.validate
+          success = Validator::Rails.new.validate
         else
           puts parser.help
         end
+        
+        return success
       end
-
     end
   end
 end

data/lib/vocab/extractor/android.rb

@@ -6,30 +6,38 @@ module Vocab
         DIFF = 'strings.diff.xml'
         FULL = 'strings.full.xml'
 
-        def extract_current( path = nil )
-          path ||= "#{Vocab.root}/res/values/strings.xml"
+        STRINGS_XML = 'res/values/strings.xml'
+
+        def current_strings( path = nil )
+          path ||= "#{Vocab.root}/#{STRINGS_XML}"
           return Vocab::Translator::Android.hash_from_xml( path )
         end
 
-        def extract_previous( path = nil )
-          path ||= "res/values/strings.xml"
-          sha = Vocab.settings.last_translation
-          xml = previous_file( path, sha )
-
-          tmpfile = "#{Vocab.root}/tmp/last_translation/#{File.basename(path)}"
-          FileUtils.mkdir_p( File.dirname( tmpfile ) )
-          File.open( tmpfile, 'w' ) { |f| f.write( xml ) }
+        def previous_strings( path = nil )
+          path ||= STRINGS_XML
+          tmpfile = tmp_file( path )
           return Vocab::Translator::Android.hash_from_xml( tmpfile )
         end
 
-        def write_diff( diff, path = nil )
+        def current_plurals( path = nil )
+          path ||= "#{Vocab.root}/#{STRINGS_XML}"
+          return Vocab::Translator::Android.plurals_from_xml( path )
+        end
+
+        def previous_plurals( path = nil )
+          path ||= STRINGS_XML
+          tmpfile = tmp_file( path )
+          return Vocab::Translator::Android.plurals_from_xml( tmpfile )
+        end
+
+        def write_diff( strings, plurals, path = nil )
           path ||= "#{Vocab.root}/#{DIFF}"
-          Vocab::Translator::Android.write( diff, path )
+          Vocab::Translator::Android.write( strings, plurals, path )
         end
 
-        def write_full( diff, path = nil )
+        def write_full( strings, plurals, path = nil )
           path ||= "#{Vocab.root}/#{FULL}"
-          Vocab::Translator::Android.write( diff, path )
+          Vocab::Translator::Android.write( strings, plurals, path )
         end
 
         def examples( locales_dir = nil )
@@ -50,6 +58,15 @@ tmp/translations/values-zh-rCN/strings.xml
           super( values )
         end
 
+        def tmp_file( path )
+          sha = Vocab.settings.last_translation
+          xml = previous_file( path, sha )
+          tmpfile = "#{Vocab.root}/tmp/last_translation/#{File.basename(path)}"
+          FileUtils.mkdir_p( File.dirname( tmpfile ) )
+          File.open( tmpfile, 'w' ) { |f| f.write( xml ) }
+          return tmpfile
+        end
+
       end
     end
   end

data/lib/vocab/extractor/base.rb

@@ -3,11 +3,14 @@ module Vocab
     class Base
       class << self
         def extract( diff_path = nil, full_path = nil )
-          current = extract_current
-          previous = extract_previous
-          diff = diff( previous, current )
-          write_diff( diff, diff_path )
-          write_full( current, full_path )
+          all_strings = current_strings
+          all_plurals = current_plurals
+
+          updated_strings = diff( previous_strings, all_strings )
+          updated_plurals = diff( previous_plurals, all_plurals )
+          write_diff( updated_strings, updated_plurals, diff_path )
+          write_full( all_strings, all_plurals, full_path )
+          update_settings
           mkdir_examples
           print_instructions
         end
@@ -26,19 +29,32 @@ module Vocab
           return diff
         end
 
-        def extract_previous
-          raise "extract_previous not implemented"
+        def update_settings
+          sha = Vocab.settings.update_translation
+          Vocab.ui.say( "Updated current translation to #{sha}" )
         end
 
-        def extract_current
-          raise "extract_current not implemented"
+        def previous_strings
+          raise "previous_strings not implemented"
         end
 
-        def write_diff( diff, path )
+        def current_strings
+          raise "current_strings not implemented"
+        end
+
+        def current_plurals
+          raise "current_plurals not implemented"
+        end
+
+        def previous_plurals
+          raise "previous_plurals not implemented"
+        end
+
+        def write_diff( diff, plurals, path )
           raise "write_diff not implemented"
         end
 
-        def write_full( diff, path )
+        def write_full( diff, plurals, path )
           raise "write_full not implemented"
         end
 

data/lib/vocab/extractor/rails.rb

@@ -5,14 +5,14 @@ module Vocab
       FULL = 'en.full.yml'
 
       class << self
-        def write_diff( diff, path )
+        def write_diff( strings, plurals, path )
           path ||= "#{Vocab.root}/#{DIFF}"
-          write( diff, path )
+          write( strings, path )
         end
 
-        def write_full( full, path )
+        def write_full( strings, plurals, path )
           path ||= "#{Vocab.root}/#{FULL}"
-          write( full, path )
+          write( strings, path )
         end
 
         def write( translations, path )
@@ -21,7 +21,7 @@ module Vocab
           Vocab.ui.say( "Extracted to #{path}" )
         end
 
-        def extract_previous( locales_root = nil )
+        def previous_strings( locales_root = nil )
           locales_root ||= "config/locales"
           tmpdir = "#{Vocab.root}/tmp/last_translation"
           FileUtils.rm_rf( "#{tmpdir}/*" )
@@ -41,11 +41,21 @@ module Vocab
           return translations( tmpdir )
         end
 
-        def extract_current( locales_root = nil )
+        def current_strings( locales_root = nil )
           locales_root ||= "#{Vocab.root}/config/locales"
           return translations( locales_root )
         end
 
+        # Treat this as a no-op because plurals handled like normal strings
+        def previous_plurals
+          return {}
+        end
+
+        # Treat this as a no-op because plurals handled like normal strings
+        def current_plurals
+          return {}
+        end
+
         def translations( dir )
           translator = Vocab::Translator::Rails.new
           translator.load_dir( dir )

data/lib/vocab/merger/android.rb

@@ -8,10 +8,26 @@ module Vocab
       end
 
       def merge_file( path )
-        keys = english_keys
-        current = current_for_locale( path )
-        updates = updates_for_locale( path )
+        strings = strings( path )
+        plurals = plurals( path )
+        Vocab::Translator::Android.write( strings, plurals, path )
+      end
+
+      def strings( path )
+        keys = string_keys
+        current = current_strings_for_locale( path )
+        updates = update_strings_for_locale( path )
+        return translation_hash( keys, current, updates, path )
+      end
 
+      def plurals( path )
+        keys = plural_keys
+        current = current_plurals_for_locale( path )
+        updates = update_plurals_for_locale( path )
+        return translation_hash( keys, current, updates, path )
+      end
+
+      def translation_hash( keys, current, updates, path )
         translation = {}
         keys.each do |key|
           next if Vocab::Translator::Base.ignore_key?( key )
@@ -24,24 +40,33 @@ module Vocab
           end
         end
 
-        Vocab::Translator::Android.write( translation, path )
+        return translation
       end
 
-      def english_keys
-        return Vocab::Translator::Android.english_keys( @locales_dir )
+      def string_keys
+        return Vocab::Translator::Android.string_keys( @locales_dir )
       end
 
-      def current_for_locale( path )
-        Vocab::Translator::Android.hash_from_xml( path )
+      def plural_keys
+        return Vocab::Translator::Android.plural_keys( @locales_dir )
       end
 
-      def updates_for_locale( path )
-        name = path.gsub( "#{@locales_dir}/", '' )
-        dirname = File.dirname( name )
-        entries = Dir.glob( "#{updates_dir}/#{dirname}/*.xml" )
-        Vocab.ui.warn( "Multiple update files for #{path}: #{entries.join( ',' )}" ) if entries.size > 1
-        update = entries.first
-        Vocab::Translator::Android.hash_from_xml( update )
+      def current_strings_for_locale( path )
+        return Vocab::Translator::Android.hash_from_xml( path )
+      end
+
+      def update_strings_for_locale( path )
+        update = update_file_path( path )
+        return Vocab::Translator::Android.hash_from_xml( update )
+      end
+
+      def current_plurals_for_locale( path )
+        return Vocab::Translator::Android.plurals_from_xml( path )
+      end
+
+      def update_plurals_for_locale( path )
+        update = update_file_path( path )
+        return Vocab::Translator::Android.plurals_from_xml( update )
       end
 
       def translation_locales
@@ -54,6 +79,14 @@ module Vocab
         end
       end
 
+      def update_file_path( path )
+        name = path.gsub( "#{@locales_dir}/", '' )
+        dirname = File.dirname( name )
+        entries = Dir.glob( "#{updates_dir}/#{dirname}/*.xml" )
+        Vocab.ui.warn( "Multiple update files for #{path}: #{entries.join( ',' )}" ) if entries.size > 1
+        return entries.first
+      end
+
     end
   end
 end

data/lib/vocab/merger/base.rb

@@ -4,17 +4,11 @@ module Vocab
 
       attr_accessor :locales_dir, :updates_dir
 
-      def update_settings
-        sha = Vocab.settings.update_translation
-        Vocab.ui.say( "Updated current translation to #{sha}" )
-      end
-
       def merge
         files_to_merge.each do |file|
           Vocab.ui.say( "Merging file: #{file}" )
           merge_file( file )
         end
-        update_settings
       end
     end
   end

data/lib/vocab/translator/android.rb

@@ -3,29 +3,77 @@ module Vocab
     class Android < Base
 
       def self.hash_from_xml( path )
-        xml = File.open( path ) { |f| f.read }
-        doc = Nokogiri::HTML.fragment( xml ) { |config| config.noblanks }
+        doc = doc_from_xml( path )
         children = doc.search( 'resources/string' )
         hash = {}
-        children.each { |child| hash[ child['name'] ] = child.text }
+        children.each do |child|
+          text = child.text
+          # escape apostrophes for android resource loader
+          text = text.gsub( /([^\\])'/, %q[\1\\\'] )
+          hash[ child['name'] ] = text
+        end
         return hash
       end
 
-      def self.write( hash, path )
+      # Extracts plural definitions from xml to a hash
+      #
+      # For example:
+      #
+      #     <plurals name="user_count">
+      #         <item quantity="one">1 user</item>
+      #         <item quantity="many">%d users</item>
+      #     </plurals>
+      #
+      # Is returned as:
+      #
+      #     { "user_count" => { "one"  => "1 user",
+      #                         "many" => "%d users" } }
+      def self.plurals_from_xml( path )
+        doc = doc_from_xml( path )
+
+        plurals = {}
+        doc.search( 'resources/plurals' ).each do |plural|
+          items = {}
+          plural.search( 'item' ).each do |item|
+            items[ item['quantity' ] ] = item.text
+          end
+
+          plurals[ plural['name'] ] = items
+        end
+        return plurals
+      end
+
+      def self.write( strings, plurals, path )
         builder = Nokogiri::XML::Builder.new do |xml|
-          xml.resources {
-            hash.sort.each do |key, value|
+          xml.resources do
+            strings.sort.each do |key, value|
               xml.string( value, :name => key )
             end
-          }
+
+            plurals.keys.sort.each do |key|
+              xml.plurals( :name => key ) do
+                plurals[ key ].each do |quantity, value|
+                  xml.item( value, :quantity => quantity )
+                end
+              end
+            end
+          end
         end
         File.open( path, 'w' ) { |f| f.write( builder.to_xml( :encoding => 'UTF-8' ) ) }
       end
 
-      def self.english_keys( locales_dir )
+      def self.string_keys( locales_dir )
         path = "#{locales_dir}/values/strings.xml"
         translations = Vocab::Translator::Android.hash_from_xml( path )
-        return translations.keys
+        keys = translations.keys.map { |key| Vocab::Translator::Base.ignore_key?( key ) ? nil : key }.compact
+        return keys
+      end
+
+      def self.plural_keys( locales_dir )
+        path = "#{locales_dir}/values/strings.xml"
+        translations = Vocab::Translator::Android.plurals_from_xml( path )
+        keys = translations.keys.map { |key| Vocab::Translator::Base.ignore_key?( key ) ? nil : key }.compact
+        return keys
       end
 
       def self.locales( dir, strict = true )
@@ -38,6 +86,16 @@ module Vocab
         return locales
       end
 
+      #########################################################################
+      # Helper methods
+      #########################################################################
+
+      def self.doc_from_xml( path )
+        xml = File.open( path ) { |f| f.read }
+        doc = Nokogiri::HTML.fragment( xml ) { |config| config.noblanks }
+        return doc
+      end
+
     end
   end
 end

data/lib/vocab/validator/android.rb

@@ -10,8 +10,8 @@ module Vocab
         return Vocab::Translator::Android.hash_from_xml( path ).keys
       end
 
-      def english_keys( path = nil )
-        return Vocab::Translator::Android.english_keys( @locales_dir )
+      def string_keys( path = nil )
+        return Vocab::Translator::Android.string_keys( @locales_dir )
       end
 
       def files_to_validate

data/lib/vocab/validator/base.rb

@@ -2,13 +2,19 @@ module Vocab
   module Validator
     class Base
 
+      # Returns false if validation fails
       def validate
+        ok = true
+        
         files = files_to_validate
         Vocab.ui.say( "#{files.size} file(s) to validate in #{@locales_dir}" )
         files.each do |path|
           validation = validate_file( path )
           print( path, validation )
+          ok &&= validation[ :missing ] && validation[ :missing ].empty?
         end
+        
+        return ok
       end
 
       def print( path, validation )
@@ -27,7 +33,7 @@ module Vocab
 
       def validate_file( path )
         other = other_keys( path )
-        english = english_keys( path )
+        english = string_keys( path )
 
         result = {}
         result[ :missing ] = ( english - other ).sort

data/lib/vocab/validator/rails.rb

@@ -10,7 +10,7 @@ module Vocab
         return flattened_keys( path )
       end
 
-      def english_keys( path )
+      def string_keys( path )
         return flattened_keys( Vocab::Translator::Rails.en_equivalent_path( path ) )
       end
 

data/lib/vocab/version.rb

@@ -1,3 +1,3 @@
 module Vocab
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/data/android/locales/values/strings.xml

@@ -7,4 +7,15 @@
     <string name="cancel">Cancel</string>
     <string name="delete">Delete</string>
     <string name="not_in_es">This key not in spanish</string>
+    <string name="debug_key">Should be ignored</string>
+
+    <plurals name="user_count">
+         <item quantity="one">1 user</item>
+         <item quantity="many">%d users</item>
+    </plurals>
+
+    <plurals name="fish_count">
+         <item quantity="one">1 fish</item>
+         <item quantity="many">%d fish</item>
+    </plurals>
 </resources>

data/spec/data/android/locales/values-es/strings.xml

@@ -3,4 +3,9 @@
     <string name="app_name">Modo Niños</string>
     <string name="pd_app_name">el Panel para padres</string>
     <string name="app_current">actual</string>
+
+    <plurals name="fish_count">
+         <item quantity="one">1 pescado</item>
+         <item quantity="many">%d peces</item>
+    </plurals>
 </resources>