i18n-translators-tools 0.2.2 → 0.2.3

data/README.md

@@ -1,8 +1,8 @@
 I18n translation and locales management utility
 ===============================================
 
-This package brings you useful utility which can help you to handle locale files
-and translations in your Ruby projects.
+This package brings you useful utility and library which can help you to handle
+locale files and translations in your Ruby projects.
 
 
 Interesting features
@@ -11,7 +11,7 @@ Interesting features
 * no database required
 * merging and changes propagation (adding, removing and changed default text)
   keeping default file untouched
-* creating new locale file based default file
+* creating new locale file based on default file
 * converting from one format to another (yml <=> rb <=> po <=> ts <=> properties)
 * statistics
 * built-in simple console translator
@@ -58,6 +58,35 @@ WARNING
   put all your rules to separate file and use exclude (repeatable) argument
   or create configuration file for your project in locales directory including
   exclude array.
+* **in your set of keys in leaf can't be ALL keys reserved words**
+  this is ok:
+
+      en:
+        my:
+          key:
+            message: "some message"
+            reference: "http://..."
+
+  but this is NOT
+
+      en:
+        my:
+          key:
+            reference: "http://..."
+
+  **Reserved keywords are: **
+  * comment
+  * default
+  * extracted_comment
+  * file
+  * flag
+  * fuzzy
+  * line
+  * old
+  * old_default
+  * reference
+  * t
+  * translation
 * **po files are supported only partialy.** If you convert from yaml or ruby to
   po and back you don't have to care even if you are using pluralization.
   If you are converting from po origin files then you can lose header of the
@@ -105,8 +134,7 @@ can native speakers put their polished english. I think it is good thing
 to put all default strings into separate file(s). If you need to change
 some text you don't have to touch source code.
 
-Default files have to be in the I18n simple format. The enhanced format
-is only for locales.
+_(Default files can be now in enhanced format.)_
 
 So in your application you should do something like this:
 
@@ -136,6 +164,11 @@ untranslated strings this can fix the problem.
 Examples
 --------
 
+**Simple conversion from one file format to another:**
+
+    $> i18n-translate cze.yml cze.po
+    $> i18n-translate cze.po cze.properties
+
 Suppose we have our locales in 'locale/' directory without sub-directories and
 default values are inside 'locale/default.yml' file. And we have two files
 with locales 'locale/de_DE.yml', 'locale/cs_CZ.yml' and 'locale/extra/cs_CZ.yml'
@@ -237,6 +270,10 @@ New format looks like:
       old_default: "old default string"
       default: "new default string"
       comment: "translator's comments"
+      extracted_comment: "po extracted comment"
+      reference: "po's reference"
+      file: "file parsed from reference"
+      line: "line parsed from po reference"
       translation: "translation itself"
       flag: "one of (ok || incomplete || changed || untranslated)"
       fuzzy: true # exists only where flag != ok (nice to have when you want
@@ -258,8 +295,8 @@ Pluralized variant should look like:
 
 As you can see the old format is string and the new format is hash.
 If you use lambdas and procs objects, you should save them in separate
-file(s) because i18n-translate utility can't handle them but Translate backend
-can.
+file(s) in different (sub)directory because i18n-translate utility can't
+handle them but Translate backend can.
 
 
 Configure file format

data/bin/i18n-translate

@@ -82,16 +82,6 @@ CONFIG FILE
 end
 
 
-COMMANDS = %w(list stat create merge convert strip translate)
-command = ARGV.shift
-
-unless COMMANDS.include?(command)
-  print_help()
-  exit
-end
-
-
-
 begin
   require 'rubygems'
 rescue
@@ -101,6 +91,40 @@ require 'i18n'
 require 'i18n-translate'
 
 
+# converts from one file format to another
+def convert(src, trg)
+  fname = File.basename(src)
+  tfname = File.basename(trg)
+  lang, format = $1, $2 if fname =~ /(.*)\.([^\.]*)$/
+  raise "bad file name '#{src}'" unless lang and format
+  tlang, tformat = $1, $2 if fname =~ /(.*)\.([^\.]*)$/
+  raise "bad file name '#{src}'" unless tlang and tformat
+
+  dir = File.dirname(src)
+  opts = {:locale_dir => dir, :locale => lang, :format => format, :default => lang}
+  tr = I18n::Translate::Translate.new(lang, opts)
+  data = {tlang => tr.target}
+  I18n::Translate::Processor.write(trg, data, tr)
+end
+
+
+COMMANDS = %w(list stat create merge convert strip translate)
+command = ARGV.shift
+
+unless COMMANDS.include?(command)
+  if (ARGV.size == 1) and File.exists?(command)
+    if File.exists?(ARGV[0])
+      puts "!!! convert fails: file #{ARGV[0]} exists"
+      exit
+    end
+    convert(command, ARGV[0])
+    exit
+  end
+  print_help()
+  exit
+end
+
+
 def process_locale(tr, command, opts)
   options = opts.dup
   options.delete(:quiet) if command == 'list'

data/i18n-translators-tools.gemspec

@@ -13,7 +13,7 @@ spec = Gem::Specification.new do |s|
   s.email = "pejuko@gmail.com"
   s.authors = ["Petr Kovar"]
   s.name = 'i18n-translators-tools'
-  s.version = '0.2.2'
+  s.version = '0.2.3'
   s.date = Time.now.strftime("%Y-%m-%d")
   s.add_dependency('i18n', '>= 0.4.1')
   s.add_dependency('ya2yaml')
@@ -61,6 +61,12 @@ Changelog:
     * fix: for default format autodetection works again
     * merge can be more verbose
 
+  v0.2.3
+    * fix: hash_to_keys can work with enhanced format => default can be in
+      enchanced format
+    * i18n-translate <source file> <target file>
+      automaticlay perform convert action from one file to another
+
 For more information read README.md and CHANGELOG.md
 
 -----------------------------------------------------------------------------
@@ -70,10 +76,11 @@ http://github.com/pejuko/i18n-translators-tools
 =============================================================================
 EOF
   s.description = <<EOF
-This package brings you useful utility which can help you to handle locale files
-and translations in your Ruby projects. Offers also built-in simple console editor.
-Supported formats are YAML, Ruby, Gettext po, QT Linguist TS and Java Properties.
-Read README.md file and run i18n-translate without parameters for more information.
+This package brings you useful utility and library which can help you to handle
+locale files and translations in your Ruby projects. Offers also built-in simple
+console editor. Supported formats are YAML, Ruby, Gettext po, QT Linguist TS and
+Java Properties. Read README.md file and run i18n-translate without parameters
+for more information.
 EOF
 end
 

data/lib/i18n/backend/translate.rb

@@ -21,9 +21,11 @@ module I18n
         result = super(locale, key, options)
         return nil if result.kind_of?(String) and result.empty?
         return result unless result.kind_of?(Hash)
-        return nil unless result[:t] or result[:translation]
+        return nil unless result[:t] or result[:translation] or result[:default]
 
         tr = result[:translation] || result[:t]
+        tr = result[:default] if tr.to_s.empty?
+
         return nil if tr.to_s.empty?
 
         values = options.except(*I18n::Backend::Base::RESERVED_KEYS)

data/lib/i18n/processor.rb

@@ -12,10 +12,12 @@ module I18n::Translate
       attr_reader :processors
     end
 
+    # append processor to the registry
     def self.<<(processor)
       @processors << processor
     end
 
+    # find processor for fname and use it to read data
     def self.read(fname, tr)
       processor = find_processor(fname)
       raise "Unknown file format" unless processor
@@ -23,6 +25,7 @@ module I18n::Translate
       worker.read
     end
 
+    # find processor for fname and use it to save data
     def self.write(fname, data, tr)
       processor = find_processor(fname)
       raise "Unknown file format `#{fname}'" unless processor
@@ -30,6 +33,7 @@ module I18n::Translate
       worker.write(data)
     end
 
+    # find appropriate processor for given file name
     def self.find_processor(fname)
       @processors.each do |processor|
         return processor if processor.can_handle?(fname)
@@ -37,6 +41,7 @@ module I18n::Translate
       nil
     end
 
+    # register formats from all known processors
     def self.init(default='yml')
       @processors.each do |processor|
         processor.register(default)
@@ -44,15 +49,19 @@ module I18n::Translate
     end
 
 
+    # this is abstract class for processors. processors should mainly implement
+    # protected methdos import and export
     class Template
       FORMAT = []
 
+      # register new processor
       def self.inherited(processor)
         Processor << processor
       end
 
       attr_reader :filename, :translate
 
+      # initialize new processor
       def initialize(fname, tr)
         @filename = fname
         @translate = tr
@@ -60,6 +69,7 @@ module I18n::Translate
         @lang = $1.to_s.strip
       end
 
+      # register proessors's formats
       def self.register(default='yml')
         self::FORMAT.each do |format|
           unless I18n::Translate::FORMATS.include?(format)
@@ -73,6 +83,7 @@ module I18n::Translate
         end
       end
 
+      # read file into hash
       def read
         data = File.open(@filename, mode("r")) do |f|
           f.flock File::LOCK_SH
@@ -81,6 +92,7 @@ module I18n::Translate
         import(data)
       end
 
+      # write hash to file
       def write(data)
         File.open(@filename, mode("w")) do |f|
           f.flock File::LOCK_EX
@@ -88,6 +100,7 @@ module I18n::Translate
         end
       end
 
+      # check if processor can handle this file
       def self.can_handle?(fname)
         fname =~ %r{\.([^\.]+)$}i
         self::FORMAT.include?($1)
@@ -95,14 +108,17 @@ module I18n::Translate
 
     protected
 
+      # converts raw data from file to hash
       def import(data)
         data
       end
 
+      # converts hash to raw
       def export(data)
         data
       end
 
+      # converts inspected string back into normal string
       def uninspect(str)
         return nil unless str
         str.gsub(%r!\\([\\#"abefnrstvx]|u\d{4}|u\{[^\}]+\}|\d{1,3}|x\d{1,2}|cx|C-[a-zA-Z]|M-[a-zA-Z])!) do |m|
@@ -116,22 +132,29 @@ module I18n::Translate
         end
       end
 
-      # convert old and shorthand fields
+      # convert old, t shorthand fields
       def migrate(data)
         keys = I18n::Translate.hash_to_keys(data, @translate.options[:separator])
         keys.each do |key|
-          k, prop = $1, $2 if key =~ /(.*)\.([^\.]+)$/
-          next unless prop or k
-          next unless ["old", "t"].include?(prop)
-          entry = I18n::Translate.find(k, data, @translate.options[:separator])
-          value = entry.delete(prop)
-          prop = (prop == "old") ? "old_default" : "translation"
-          entry[prop] = value
-          I18n::Translate.set(k, entry, data, @translate.options[:separator])
+          entry = I18n::Translate.find(key, data, @translate.options[:separator])
+          next unless I18n::Translate.is_enhanced?(entry)
+          %w(old t).each do |prop|
+            next unless entry[prop]
+            value = entry.delete(prop)
+            prop = case(prop)
+                   when "old"
+                     "old_default"
+                   when "t"
+                     "translation"
+                   end
+            entry[prop] = value
+          end
+          I18n::Translate.set(key, entry, data, @translate.options[:separator])
         end
         data
       end
 
+      # in ruby 1.9 it sets encoding for opening IOs
       def mode(m)
         mode = m.dup
         mode << ":" << @translate.options[:encoding] if defined?(Encoding)

data/lib/i18n/translate.rb

@@ -53,6 +53,7 @@ module I18n::Translate
   # function I18n::Translate::Processor.init will register known
   # formats
   FORMATS = %w() # the first one is preferred if :format => auto
+  RESERVED_WORDS = %w(comment extracted_comment reference file line default old_default fuzzy flag translation old t)
 
   # read configuration file
   # config format is ruby file which returns hash
@@ -60,12 +61,22 @@ module I18n::Translate
     eval File.read(filename)
   end
 
+  # checks if all keys are reserved keywords
+  def self.is_enhanced?(hash)
+    return false unless hash.kind_of?(Hash)
+    hash.keys.each do |key|
+      return false unless I18n::Translate::RESERVED_WORDS.include?(key)
+    end
+    true
+  end
+
   # returns flat array of all keys e.g. ["system.message.ok", "system.message.error", ...]
   def self.hash_to_keys(hash, separator=".", prefix="")
     res = []
     hash.keys.each do |key|
       str = prefix.empty? ? key : "#{prefix}#{separator}#{key}"
-      if hash[key].kind_of?(Hash)
+      enhanced = I18n::Translate.is_enhanced?(hash[key])
+      if hash[key].kind_of?(Hash) and (not enhanced)
         str = hash_to_keys( hash[key], separator, str )
       end
       res << str

data/test/backend.rb

@@ -51,5 +51,9 @@ module I18n::Test
       assert_equal( "tady je nějaký text", I18n.t("some text there") )
     end
 
+    def test_0120_enhanced_default_returns_default_if_translation_is_missing
+      assert_equal( "this is a key", I18n.t("test.enhanced") )
+    end
+
   end
 end

data/test/locale/src/default.yml

@@ -20,4 +20,6 @@ default:
   test:
     new_line: "In this text\nis a new line."
     quote: "This text contains \" -- one quote."
+    enhanced:
+      default: "this is a key"
   "some text there": "some text there"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: i18n-translators-tools
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Petr Kovar
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-28 00:00:00 +02:00
+date: 2010-07-30 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -49,10 +49,11 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 description: |
-  This package brings you useful utility which can help you to handle locale files
-  and translations in your Ruby projects. Offers also built-in simple console editor.
-  Supported formats are YAML, Ruby, Gettext po, QT Linguist TS and Java Properties.
-  Read README.md file and run i18n-translate without parameters for more information.
+  This package brings you useful utility and library which can help you to handle
+  locale files and translations in your Ruby projects. Offers also built-in simple
+  console editor. Supported formats are YAML, Ruby, Gettext po, QT Linguist TS and
+  Java Properties. Read README.md file and run i18n-translate without parameters
+  for more information.
 
 email: pejuko@gmail.com
 executables: 
@@ -147,6 +148,12 @@ post_install_message: |
       * fix: for default format autodetection works again
       * merge can be more verbose
   
+    v0.2.3
+      * fix: hash_to_keys can work with enhanced format => default can be in
+        enchanced format
+      * i18n-translate <source file> <target file>
+        automaticlay perform convert action from one file to another
+  
   For more information read README.md and CHANGELOG.md
   
   -----------------------------------------------------------------------------