i18n-translators-tools 0.1.1 → 0.2

data/lib/i18n/processor/yaml.rb

@@ -13,11 +13,11 @@ module I18n::Translate::Processor
   protected
 
     def import(data)
-      ::YAML.load(data)
+      migrate(::YAML.load(data))
     end
 
     def export(data)
-      data.ya2yaml
+      data.ya2yaml(:minimum_block_length => 80)
     end
 
   end

data/lib/i18n/translate.rb

@@ -6,27 +6,28 @@
 require 'fileutils'
 require 'find'
 
-require 'i18n/processor'
-
 # I18n::Translate introduces new format for translations. To make
 # I18n.t work properly you need to include Translator's backend:
 #
 #   I18n::Backend::Simple.send(:include, I18n::Backend::Translate)
 #   I18n::Backend::Simple.send(:include, I18n::Backend::Fallbacks)
 #
-# notice that Translator have to be included BEFORE Fallback otherwise
+# notice that Translator have to be included BEFORE Fallbacks otherwise
 # the fallback will get Hash (even with empty translation) and won't work.
 #
-# It is hightly recommended to use Fallback backend together with Translate.
+# It is hightly recommended to use Fallbacks backend together with Translate.
 # If you have experienced nil or empty translations this can fix the problem.
 #
 # Format of entry:
 #
-#   old: old default string
+#   old_default: old default string
 #   default: new default string
 #   comment: translator's comments
-#   t: translation
-#   line: the lines, where is this key used # not implemented yet
+#   translation: translation itself (optionaly in the file can be just t as
+#                a shorthand, however, the tools will allways write translation)
+#   extracted_comment: po compatibility
+#   file: file where it is # po compatibility
+#   line: the lines, where is this key used #  po compatibility
 #   flag: ok || incomplete || changed || untranslated
 #   fuzzy: true # exists only where flag != ok (nice to have when you want
 #                 edit files manualy)
@@ -35,20 +36,29 @@ require 'i18n/processor'
 #
 #  key:
 #    one:
-#      old:
+#      old_default:
 #      default:
-#      t:
+#      translation:
 #      ...
 #    other:
-#      old:
+#      old_default:
 #      default:
-#      t:
+#      translation:
 #      ...
 #
 module I18n::Translate
 
   FLAGS = %w(ok incomplete changed untranslated)
-  FORMATS = %w(yml rb po)       # the first one is preferred if :format => auto
+  #FORMATS = %w(yml rb po pot ts properties)       # the first one is preferred if :format => auto
+  # function I18n::Translate::Processor.init will register known
+  # formats
+  FORMATS = %w() # the first one is preferred if :format => auto
+
+  # read configuration file
+  # config format is ruby file which returns hash
+  def self.read_config(filename)
+    eval File.read(filename)
+  end
 
   # returns flat array of all keys e.g. ["system.message.ok", "system.message.error", ...]
   def self.hash_to_keys(hash, separator=".", prefix="")
@@ -59,7 +69,7 @@ module I18n::Translate
         str = hash_to_keys( hash[key], separator, str )
       end
       res << str
-    end
+    end if hash
     res.flatten
   end
 
@@ -107,8 +117,13 @@ module I18n::Translate
       locale, format = Translate.valid_file?(entry, o[:format])
       if (not format) or (locale == o[:default])
         puts "#{entry}...skipping" if o[:verbose]
-        next unless format
-        next if locale == o[:default]
+        next
+      end
+
+      # skip if not desired locale
+      if o[:locale] and (o[:locale] != "auto") and (o[:locale] != locale)
+        puts "#{entry}...skipping" if o[:verbose]
+        next 
       end
 
       exclude = false
@@ -133,7 +148,13 @@ module I18n::Translate
     locales
   end
 
-
+  # create new locale and returns I18n::Translate::Translate object
+  def self.create_locale(lang, opts={})
+    tr = I18n::Translate::Translate.new(lang, opts)
+    tr.assign(tr.merge)
+    tr.export!
+    tr
+  end
 
   # it breaks proc and lambdas objects
   class Translate
@@ -151,19 +172,20 @@ module I18n::Translate
     # loads default and lang files
     def initialize(lang, opts={})
       @lang = lang.to_s
-      raise "Empty locale" if @lang.empty?
+      raise "Empty locale" if @lang.empty? and not opts[:empty]
       @options = DEFAULT_OPTIONS.merge(opts)
       @options[:default_format] ||= @options[:format]
 
-      @default, @default_file = load_locale( @options[:default], @options[:default_format] )
-      @target, @lang_file = load_locale( @lang )
-
-      merge!
+      if @lang and not opts[:empty]
+        @default, @default_file = load_locale( @options[:default], @options[:default_format] )
+        @target, @lang_file = load_locale( @lang )
+        merge!
+      end
     end
 
     # check if the file has supported format
     def self.valid_file?(fname, format=Translate::DEFAULT_OPTIONS[:format])
-      pattern = ".*?"
+      pattern = "[^\.]+"
       pattern = format if format != "auto"
       fname =~ /\/?([^\/]*?)\.(#{pattern})$/
       locale, format = $1, $2
@@ -175,19 +197,17 @@ module I18n::Translate
 
     # will merge only one key and returns hash
     #   {
-    #     :key => 'key',
-    #     :default => '',              # value set in default file
-    #     :old_default => '',          # value set as old in target file
+    #     'key' => 'key',
+    #     'default' => '',              # value set in default file
+    #     'old_default' => '',          # value set as old in target file
     #                                    (value from default file from last translation
-    #                                     if the field has changed)
-    #     :old_t => '',                # if flag == 'changed' then old_t = t and t = ''
-    #     :t => '',                    # value set in target file
-    #     :line => 'some/file.rb: 44', # name of source file and number of line
-    #                                    (a copy in target file from default file)
-    #                                    !!! line is unused for now
-    #     :comment => ''               # a comment added by a translator
-    #     :flag => ok || incomplete || changed || untranslated    # set by merging tool except incomplete
+    #                                    if the field has changed)
+    #     'old_translation' => '',      # if flag == 'changed' then old_translation = t and t = ''
+    #     'translation' => '',          # value set in target file
+    #     'comment' => ''               # a comment added by a translator
+    #     'flag' => ok || incomplete || changed || untranslated    # set by merging tool except incomplete
     #                                                               which is set by translator
+    #    # other keys helded for compatibility with other formats
     #   }
     def [](key)
       d = I18n::Translate.find(key, @default, @options[:separator])
@@ -199,10 +219,10 @@ module I18n::Translate
       trg = I18n::Translate.find(key, @target, @options[:separator])
       if (not trg) or
          (trg.kind_of?(String) and trg.strip.empty?) or
-         (trg.kind_of?(Hash) and trg["t"].to_s.strip.empty?)
+         (trg.kind_of?(Hash) and trg["translation"].to_s.strip.empty?)
         entry["old_default"] = ""
-        entry["old_t"] = ""
-        entry["t"] = ""
+        entry["old_translation"] = ""
+        entry["translation"] = ""
         entry["comment"] = trg.kind_of?(Hash) ? trg["comment"].to_s.strip : ""
         entry["flag"] = "untranslated"
         return entry
@@ -210,24 +230,24 @@ module I18n::Translate
 
       # default has changed => new translation is probably required
       if trg.kind_of?(Hash)
-        entry["old_t"] = trg["t"].to_s.strip
-        entry["t"] = ""
+        entry["old_translation"] = trg["translation"].to_s.strip
+        entry["translation"] = ""
         entry["comment"] = trg["comment"].to_s.strip
         entry["flag"] = "changed"
 
         if d != trg["default"]
           entry["old_default"] = trg["default"].to_s.strip
           return entry
-        elsif not trg["old"].to_s.strip.empty?
-          entry["old_default"] =  trg["old"].to_s.strip
+        elsif not trg["old_default"].to_s.strip.empty?
+          entry["old_default"] =  trg["old_default"].to_s.strip
           return entry
         end
       end
 
       # nothing has changed 
-      entry["old_default"] = trg.kind_of?(Hash) ? trg["old"].to_s.strip : ""
-      entry["old_t"] = ""
-      entry["t"] = trg.kind_of?(Hash) ? trg["t"].to_s.strip : trg.to_s.strip
+      entry["old_default"] = trg.kind_of?(Hash) ? trg["old_default"].to_s.strip : ""
+      entry["old_translation"] = ""
+      entry["translation"] = trg.kind_of?(Hash) ? trg["translation"].to_s.strip : trg.to_s.strip
       entry["comment"] = trg.kind_of?(Hash) ? trg["comment"].to_s.strip : ""
       entry["flag"] = (trg.kind_of?(Hash) and trg["flag"]) ? trg["flag"].to_s.strip : "ok"
 
@@ -235,7 +255,7 @@ module I18n::Translate
     end
 
     # wrapper for I18n::Translate.find with presets options
-    def find(key, hash=@translate, separator=@options[:separator])
+    def find(key, hash=@target, separator=@options[:separator])
       I18n::Translate.find(key, hash, separator)
     end
 
@@ -261,8 +281,8 @@ module I18n::Translate
           key, values = transl
         end
 
-        old_t = values["old_t"].to_s.strip
-        new_t = values["t"].to_s.strip
+        old_t = values["old_translation"].to_s.strip
+        new_t = values["translation"].to_s.strip
         default = values["default"].to_s.strip
         old_default = values["old_default"].to_s.strip
         flag = values["flag"].to_s.strip
@@ -278,28 +298,32 @@ module I18n::Translate
           comment.force_encoding(enc)
         end
 
-        trg = {
-          "comment" => comment,
-          "flag" => flag
-        }
+        # merging with unknown fields
+        trg = find(key)
+        trg = {} if trg.nil? or not trg.kind_of?(Hash)
+        trg["comment"] = comment
+        trg["flag"] = flag
 
         if flag == "ok"
-          trg["t"] = new_t.empty? ? old_t : new_t
+          trg["translation"] = new_t.empty? ? old_t : new_t
           trg["default"] = default
-          trg["old"] = "" 
+          trg["old_default"] = "" 
         else
-          trg["t"] = new_t.empty? ? old_t : new_t
+          trg["translation"] = new_t.empty? ? old_t : new_t
           trg["default"] = default
-          trg["old"] = old_default
+          trg["old_default"] = old_default
         end
 
         # make fallback work
-        trg["t"] = nil if trg["t"].empty?
+        trg["translation"] = nil if trg["translation"].empty?
 
         # say that this entry is not completed yet
         # useful if you edit files in text editor and serching for next one
         trg["fuzzy"] = true if flag != "ok"
 
+        # clean empty values
+        trg.delete_if{ |k,v| v.to_s.empty? }
+
         self[key] = trg
       end
     end
@@ -326,9 +350,10 @@ module I18n::Translate
       keys = I18n::Translate.hash_to_keys(@default, @options[:separator])
       keys.each do |key|
         entry = I18n::Translate.find(key, @target, @options[:separator])
-        raise "Translate#[key]: wrong key '#{key}'" unless entry
+        next unless entry # skip entries that are not merged in target yet
+        #raise "Translate#[key]: wrong key '#{key}'" unless entry
         next unless entry.kind_of?(Hash)
-        self[key] = entry["t"]
+        self[key] = entry["translation"]
       end
   
       self
@@ -349,17 +374,6 @@ module I18n::Translate
       stat
     end
 
-    def to_yaml
-      trg = {@lang => @target}
-      #YAML.dump(trg)
-      trg.ya2yaml
-    end
-
-    def to_rb
-      trg = {@lang => @target}
-      trg.to_rb
-    end
-
   protected
 
     # returns first file for @lang.type
@@ -378,7 +392,8 @@ module I18n::Translate
       fname = file_name(lang, type)
 
       if File.exists?(fname)
-        return [Processor.read(fname, self)[lang], fname]
+        data = Processor.read(fname, self)
+        return [data[lang], fname]
       else
         STDERR << "Warning: I18n::Translate#load_locale: file `#{fname}' does NOT exists. Creating empty locale.\n"
       end

data/lib/i18n/translator.rb

@@ -0,0 +1,76 @@
+# -*- coding: utf-8 -*-
+# vi: fenc=utf-8:expandtab:ts=2:sw=2:sts=2
+# 
+# @author: Petr Kovar <pejuko@gmail.com>
+
+module I18n::Translate
+
+  class Translator
+    def initialize(lang, opts={})
+      @translate = I18n::Translate::Translate.new(lang, opts)
+    end
+
+    def run
+      stat = @translate.stat
+      @translate.merge.select{|x| x["flag"] != "ok"}.each_with_index do |entry, i|
+        next_entry = false
+        while not next_entry
+          puts ""
+          puts ""
+          puts "[#{@translate.default_file} + #{@translate.lang_file}]"
+          puts "(#{i+1}/#{stat[:fuzzy]}) #{entry["key"]} (#{entry["flag"]})"
+          puts "comment: #{entry["comment"]}" unless entry["comment"].empty?
+          puts "old default: #{entry["old_default"]}" unless entry["old_default"].empty?
+          puts "old translation: #{entry["old_translation"]}" unless entry["old_translation"].empty?
+          puts "default: #{entry["default"]}"
+          puts "translation: #{entry["translation"]}"
+          puts ""
+          puts "Actions:"
+          puts "n (next) t (translate) f (change flag) c (comment) s (save) q (save & quit) x(exit no saving)"
+          action = STDIN.readline.strip
+          puts ""
+          case action
+          when 'n'
+            next_entry = true
+          when 't'
+            puts "Enter translation:"
+            entry["translation"] = STDIN.readline.strip
+            entry["flag"] = "ok" unless entry["translation"].empty?
+            @translate.assign( [entry] )
+            puts "Flag sets to #{entry["flag"]}"
+          when 'f'
+            puts "Change flag to:"
+            puts "o (ok), i (incomplete), c (changed), u (untranslated)"
+            f = STDIN.readline.strip
+            I18n::Translate::FLAGS.each do |fname|
+              if fname[0,1] == f
+                entry["flag"] = fname
+                break
+              end
+            end
+            @translate.assign( [entry] )
+            puts "Flag sets to #{entry["flag"]}"
+          when 'c'
+            puts "Enter comment:"
+            entry["comment"] = STDIN.readline.strip
+            @translate.assign( [entry] )
+            puts "Comment has changed."
+          when 's'
+            @translate.export!
+            puts "Translation saved"
+          when 'q'
+            @translate.export!
+            puts "Translation saved"
+            exit
+          when 'x'
+            exit
+          end # case
+        end # while
+      end # each_with_index
+    
+      @translate.export!
+      @translate.reload!
+    end
+  end
+
+end

data/test/all.rb

@@ -0,0 +1,89 @@
+# -*- coding: utf-8 -*-
+# vi: fenc=utf-8:expandtab:ts=2:sw=2:sts=2
+# 
+# @author: Petr Kovar <pejuko@gmail.com>
+#
+$KCODE='UTF8'
+
+require 'test/unit'
+require 'rubygems'
+require 'yaml'
+
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__), ".."))
+require 'lib/i18n-translate'
+require 'test/backend'
+require 'test/processor'
+
+$current_dir = File.expand_path(File.dirname(__FILE__))
+$src_dir = File.join($current_dir, 'locale/src')
+$trg_dir = File.join($current_dir, 'locale/trg')
+
+
+    # some data for comparation
+$si = {
+  "comment" => "Comment",
+  "extracted_comment" => "Extracted Comment",
+  "reference" => "src/test.rb:31",
+  "file" => "src/test.rb",
+  "line" => "31",
+  "fuzzy" => true,
+  "flag" => "incomplete",
+  "old_default" => "Previous untranslated",
+  "default" => "Interpolated text '%{var}'",
+  "translation" => "Interpolovaný text '%{var}'"
+}
+
+
+def load_yml(default, cze)
+  tr = I18n::Translate::Translate.new('default', {:empty => true})
+  [ I18n::Translate::Processor.read(default, tr)["default"],
+    I18n::Translate::Processor.read(cze, tr)["cze"] ]
+end
+
+def load_src
+  load_yml("#{$src_dir}/default.yml", "#{$src_dir}/cze.yml")
+end
+
+def load_trg
+  load_yml("#{$trg_dir}/default.yml", "#{$trg_dir}/cze.yml")
+end
+
+def load_src_trg
+  res = {}
+  res[:src] = load_src
+  res[:trg] = load_trg
+  res
+end
+
+
+# helper for comparing Hasheds and Arrays
+# prints out differences
+def diff(src, trg)
+  return if src == trg
+  if src.kind_of?(Hash) and trg.kind_of?(Hash)
+    src.keys.each { |key| puts "src key: #{key}" unless trg.keys.include?(key) }
+    trg.keys.each { |key| puts "trg key: #{key}" unless src.keys.include?(key) }
+    src.keys.each do |key, value|
+      puts "#{key} #{src[key].inspect} != #{trg[key].inspect}" if src[key] != trg[key]
+    end
+  elsif src.kind_of?(Array) and trg.kind_of?(Array)
+    src.each {|k| puts "not in trg '#{k}'" unless trg.include?(k)}
+    trg.each {|k| puts "not in src '#{k}'" unless src.include?(k)}
+  else
+    puts "not equal types"
+  end
+end
+
+
+I18n::Backend::Simple.send(:include, I18n::Backend::Translate)
+I18n::Backend::Simple.send(:include, I18n::Backend::Fallbacks)
+I18n::Backend::Simple.send(:include, I18n::Backend::PO)
+I18n::Backend::Simple.send(:include, I18n::Backend::TS)
+I18n::Backend::Simple.send(:include, I18n::Backend::Properties)
+I18n.default_locale = 'default'
+I18n.locale = 'cze'
+
+
+Dir[File.join($current_dir, "tc_*.rb")].each do |tc|
+  load tc
+end