i18n-translators-tools 0.1.1 → 0.2

data/README.md

@@ -11,8 +11,8 @@ Interesting features
 * no database required
 * merging and changes propagation (adding, removing and changed default text)
   keeping default file untouched
-* creating new locale file based on another (usually default) file
-* converting from one format to another (yml <=> rb <=> po)
+* creating new locale file based default file
+* converting from one format to another (yml <=> rb <=> po <=> ts <=> properties)
 * statistics
 * built-in simple console translator
 * support for locales split into sub-directories like:
@@ -61,14 +61,18 @@ WARNING
 * **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
-  file, pluralization, extracted comments, some flags (fuzzy will stay) and
-  previous-context. Strings over multiple lines are supported, however.
-* **po files are not compatible with I18n::Gettext.** The main purpose of
-  enabling conversions to po files is effort to allow usage of many po editors
-  for ruby projects. It is supposed that you will keep your files in yml (rb)
-  and conversions will be used only for translators and then you convert it
-  back. Then you lose nothing.
-
+  file, pluralization, some flags (fuzzy will stay) and previous-context.
+  Strings over multiple lines are supported, however.
+* **po files are not compatible with I18n::Backend::Gettext.** The main purpose
+  of enabling conversions to po files is effort to allow usage of many po
+  editors for ruby projects. You can either keep all your files in yml and
+  convert them only for translators and then back or you can have default in
+  yml and other locales in po files. i18-translate tool will take care of it.
+* **QT TS format is not fully supported.** TS format is changing with almost
+  every qt release so i18n-translate don't support:
+  * extra-po-msgid_plural, extra-po-old_msgid_plural
+  * extra-loc-*
+  * nested context
 
 Installation
 ------------
@@ -112,6 +116,7 @@ So in your application you should do something like this:
     I18n::Backend::Simple.send(:include, I18n::Backend::Fallbacks)
     I18n.default_locale = 'default'
     I18n.load_path << Dir[ File.expand_path("../locale/*.yml", __FILE__) ]
+    I18n.locale = 'cs'
 
 and then you can use
 
@@ -119,6 +124,14 @@ and then you can use
 
 as usual.
 
+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 Fallbacks backend together with
+Translate. If you have experienced nil or empty translations due to
+untranslated strings this can fix the problem.
+
 
 Examples
 --------
@@ -145,6 +158,12 @@ with locales 'locale/de_DE.yml', 'locale/cs_CZ.yml' and 'locale/extra/cs_CZ.yml'
     locale/cs_CZ.yml...65% (650/1000)
     locale/de_DE.yml...90% (900/1000)
 
+**PO locales and default.yml**
+
+    $> i18n-translate merge
+    locale/cs_CZ.po...merged
+    locale/de_DE.po...merged
+
 **Translate more entries (built-in translator invocation):**
 
     $> i18n-translate translate -l cs_CZ
@@ -160,17 +179,43 @@ Supported formats
 
 * **po**; supported format looks like
 
-		#  there is some comment
-		#, fuzzy, changed
-		#| msgid Old default
-		msgctxt "there.is.some.key"
-		msgid "Default text"
-		msgstr "Prelozeny defaultni text"
+        #  there is some comment
+        #. extracted-comment
+        #: reference
+        #, fuzzy, changed
+        #| msgid Old default
+        msgctxt "there.is.some.key"
+        msgid "Default text"
+        msgstr "Prelozeny defaultni text"
 
   Such po file is pretty usable with po editors.
 
+  To use po files you should include this backend istead of
+  I18n::Backend::Gettext
+ 
+      I18n::Backend::Simple.send(:include, I18n::Backend::PO)
+
+  This backend can also work with natural po files. Just set your app.pot
+  as default and then you can use it:
+
+      I18n.t("some text there")
+
+  or create alias
+
+      def _(*args); I18n.t(*args); end
+      _("some text there")
+
 * **yml**; standard yaml files in I18n simple format
 * **rb**; typical ruby files in I18n simple format
+* **ts**; QT Linguist TS format. If you are planing to do translation in
+  qt linguist, convert to this format rather then to po. Include TS backend
+  if you want use this foramat for locales.
+
+      I18n::Backend::Simple.send(:include, I18n::Backend::TS)
+
+* **properties**; support for java properties locales
+
+      I18n::Backend::Simple.send(:include, I18n::Backend::Properties)
 
 
 New locale files format
@@ -189,10 +234,10 @@ or for pluralization (depends on rules) it can be similar to this:
 New format looks like:
 
     key:
-      old: "old default string"
+      old_default: "old default string"
       default: "new default string"
       comment: "translator's comments"
-      t: "translation itself"
+      translation: "translation itself"
       flag: "one of (ok || incomplete || changed || untranslated)"
       fuzzy: true # exists only where flag != ok (nice to have when you want
                     edit files manually)
@@ -201,14 +246,14 @@ Pluralized variant should look like:
 
     key:
       one:
-        old:
+        old_default:
         default:
-        t:
+        translation:
         ...
       other:
-        old:
+        old_default:
         default:
-        t:
+        translation:
         ...
 
 As you can see the old format is string and the new format is hash.
@@ -242,3 +287,8 @@ It is not necessary to use all switches.
 
 [1]: http://github.com/pejuko/i18n-web-translator
 
+
+<!--
+vi: filetype=mkd
+-->
+

data/Rakefile

@@ -2,17 +2,50 @@
 # vi: fenc=utf-8:expandtab:ts=2:sw=2:sts=2
 # 
 # @author: Petr Kovar <pejuko@gmail.com>
+$KCODE='UTF8'
 
 require 'rake/testtask'
 require 'rake/gempackagetask'
 require 'rake/clean'
 
-CLEAN << "coverage" << "pkg"
+CLEAN << "coverage" << "pkg" << "README.html" << "CHANGELOG.html"
 
-task :default => [:test]
+task :default => [:test, :doc, :gem]
 Rake::TestTask.new(:test) do |t|
-  t.pattern = File.join(File.dirname(__FILE__), 'test/tc_*.rb')
+  t.pattern = File.join(File.dirname(__FILE__), 'test/all.rb')
   t.verbose = true
 end
 
 Rake::GemPackageTask.new(eval(File.read("i18n-translators-tools.gemspec"))) {|pkg|}
+
+desc "Test with rcov"
+task :rcov do |t| 
+  system "rcov  --exclude .rvm,lib/ruby --sort coverage --text-summary --text-coverage-diff -o coverage  test/all.rb"
+end
+
+begin
+  require 'bluecloth'
+
+  def build_document(mdfile)
+    fname = $1 if mdfile =~ /(.*)\.md$/
+    raise "Unknown file type" unless fname
+
+    data = File.read(mdfile)
+    md = Markdown.new(data)
+    htmlfile = "#{fname}.html"
+
+    File.open(htmlfile, "w") { |f| f << md.to_html }
+  end
+
+  task :doc => [:readme, :changelog]
+
+  task :readme do |t|
+    build_document("README.md")
+  end
+
+  task :changelog do |t|
+    build_document("CHANGELOG.md")
+  end
+
+rescue
+end

data/bin/i18n-translate

@@ -6,6 +6,8 @@
 
 $KCODE="UTF8"
 
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__), "../lib"))
+
 def print_help
   print $0
   puts " <command> [options] [locale directory]"
@@ -45,6 +47,7 @@ options:
   --locale=<locale>, -l <locale>      -- work with specific locale only
                                          e.g: create -p locale -l cs_CZ
   --deep, -r                          -- scan locale_dir recursively
+  --encoding, -e                      -- set encoding of files (default: utf-8)
   --quiet, -q                         -- show less information
   --verbose, -v                       -- shows more information during
                                          locales processing
@@ -61,7 +64,7 @@ CONFIG FILE
 
          Example:
 
-         options = {
+         {
            :exclude => ['rules'],
            :verbose => true,
            :format => 'yml',
@@ -149,6 +152,7 @@ opts = GetoptLong.new(
   ["--separator", "-s", GetoptLong::REQUIRED_ARGUMENT],
   ["--target", "-t", GetoptLong::REQUIRED_ARGUMENT],
   ["--deep", "-r", GetoptLong::NO_ARGUMENT],
+  ["--encoding", "-e", GetoptLong::REQUIRED_ARGUMENT],
   ["--verbose", "-v", GetoptLong::NO_ARGUMENT],
   ["--quiet", "-q", GetoptLong::NO_ARGUMENT],
   ["--locale", "-l", GetoptLong::REQUIRED_ARGUMENT]
@@ -158,7 +162,7 @@ opts = GetoptLong.new(
 # setting up default options
 user_config_file = File.join(ENV["HOME"], ".config/ruby/i18n-translate")
 options = I18n::Translate::Translate::DEFAULT_OPTIONS.dup
-options.merge!(eval( File.read(user_config_file) )) if File.exists?(user_config_file)
+options.merge!(I18n::Translate.read_config(user_config_file)) if File.exists?(user_config_file)
 options[:exclude] ||= []
 
 
@@ -195,7 +199,7 @@ end
 locale_dir = tmp[:locale_dir] ? tmp[:locale_dir] : options[:locale_dir]
 # reading project locale config options
 locale_config_file = File.join(locale_dir, ".i18n-translate")
-options.merge!(eval( File.read(locale_config_file) )) if File.exists?(locale_config_file)
+options.merge!(I18n::Translate.read_config(locale_config_file)) if File.exists?(locale_config_file)
 
 # merge command line arguments
 options.merge!(tmp)
@@ -219,9 +223,7 @@ when 'create'
     exit 2
   end
 
-  tr = I18n::Translate::Translate.new(options[:locale], options.merge({:format => format}))
-  tr.assign(tr.merge)
-  tr.export!
+  tr = I18n::Translate.create_locale(options[:locale], options.merge({:format => format}))
 
   puts "#{tr.options[:locale_dir]}/#{tr.lang}...created" unless options[:quiet]
 
@@ -232,71 +234,12 @@ when 'translate'
     exit 1
   end
 
-  tr = I18n::Translate::Translate.new(options[:locale], options)
-  stat = tr.stat
-  tr.merge.select{|x| x["flag"] != "ok"}.each_with_index do |entry, i|
-    next_entry = false
-    while not next_entry
-      puts ""
-      puts ""
-      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_t"]}" unless entry["old_t"].empty?
-      puts "default: #{entry["default"]}"
-      puts "translation: #{entry["t"]}"
-      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["t"] = STDIN.readline.strip
-        entry["flag"] = "ok" unless entry["t"].empty?
-        tr.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
-        tr.assign( [entry] )
-        puts "Flag sets to #{entry["flag"]}"
-      when 'c'
-        puts "Enter comment:"
-        entry["comment"] = STDIN.readline.strip
-        tr.assign( [entry] )
-        puts "Comment has changed."
-      when 's'
-        tr.export!
-        puts "Translation saved"
-      when 'q'
-        tr.export!
-        puts "Translation saved"
-        exit
-      when 'x'
-        exit
-      end # case
-    end # while
-  end # each_with_index
-
-  tr.export!
-  tr.reload!
+  translator = I18n::Translate::Translator.new(options[:locale], options)
+  translator.run
+
 else
 
   I18n::Translate.scan(options) do |tr|
-    # skip if not desired locale
-    next if options[:locale] and (options[:locale] != tr.lang)
-
     process_locale(tr, command, options)
   end
 

data/i18n-translators-tools.gemspec

@@ -9,19 +9,60 @@ require 'find'
 spec = Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.summary = "I18n transation utility which helps to manage files with locales."
+  s.homepage = "http://github.com/pejuko/i18n-translators-tools"
   s.email = "pejuko@gmail.com"
   s.authors = ["Petr Kovar"]
   s.name = 'i18n-translators-tools'
-  s.version = '0.1.1'
-  s.date = '2010-07-17'
+  s.version = '0.2'
+  s.date = '2010-07-27'
   s.add_dependency('i18n', '>= 0.4.1')
   s.add_dependency('ya2yaml')
   s.require_path = 'lib'
-  s.files = ["bin/i18n-translate", "test/tc_translate.rb", "test/locale/src/default.yml", "test/locale/src/cze.yml", "test/locale/src/cze.rb", "test/locale/src/cze.po", "lib/i18n-translate.rb", "lib/i18n/translate.rb", "lib/i18n/processor.rb", "lib/i18n/processor/yaml.rb", "lib/i18n/processor/ruby.rb", "lib/i18n/processor/gettext.rb", "lib/i18n/backend/translate.rb", "README.md", "i18n-translators-tools.gemspec", "Rakefile"]
+  s.files = ["bin/i18n-translate", "README.md", "i18n-translators-tools.gemspec", "Rakefile"]
+  s.files += Dir["lib/**/*.rb", "test/**/*.{rb,yml,po}"]
   s.executables = ["i18n-translate"]
+  s.post_install_message = <<EOF
+=======================================================================
+
+I18N TRANSLATORS TOOLS
+
+-----------------------------------------------------------------------
+
+Supported formats:
+  * yml
+  * rb
+  * ts
+  * po
+  * properties
+
+Backends:
+  * Extended format. i18n-translators-tools bring extended format
+    I18n::Backend::Simple.send(:include, I18n::Backend::Translator)
+  * Gettext po
+    I18n::Backend::Simple.send(:include, I18n::Backend::PO)
+  * QT Linguist TS
+    I18n::Backend::Simple.send(:include, I18n::Backend::TS)
+  * Java Properties files
+    I18n::Backend::Simple.send(:include, I18n::Backend::Properties)
+
+Functions:
+  * merge
+  * convert
+  * translate (built-in simple console translator)
+  * statistics
+
+For more information read README.md and CHANGELOG.md
+
+-----------------------------------------------------------------------
+
+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.
 EOF
 end

data/lib/i18n-translate.rb

@@ -9,5 +9,10 @@ dir = File.expand_path(File.dirname(__FILE__))
 $:.unshift(dir) unless $:.include?(dir)
 
 require 'i18n/backend/translate'
+require 'i18n/backend/po'
+require 'i18n/backend/ts'
+require 'i18n/backend/properties'
 require 'i18n/translate'
+require 'i18n/processor'
+require 'i18n/translator'
 

data/lib/i18n/backend/po.rb

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+# vi: fenc=utf-8:expandtab:ts=2:sw=2:sts=2
+# 
+# @author: Petr Kovar <pejuko@gmail.com>
+
+module I18n::Backend
+
+  # to use po files generated (e.g: by merge) by i18n-translate you should
+  # include this backend istead of I18n::Backend::Gettext
+  #
+  # I18n::Backend::Simple.send(:include, I18n::Backend::PO)
+  module PO
+  protected
+    def load_po(fname)
+      locale = ::File.basename(fname, '.po')
+      tr = I18n::Translate::Translate.new(locale, {:empty => true})
+      data = I18n::Translate::Processor::Gettext.new(fname, tr).read
+    end
+  end
+end

data/lib/i18n/backend/properties.rb

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+# vi: fenc=utf-8:expandtab:ts=2:sw=2:sts=2
+# 
+# @author: Petr Kovar <pejuko@gmail.com>
+
+module I18n::Backend
+
+  # to use Java properties files you should just include this backend
+  #
+  # I18n::Backend::Simple.send(:include, I18n::Backend::Properties)
+  module Properties
+  protected
+    def load_properties(fname)
+      locale = ::File.basename(fname, '.properties')
+      tr = I18n::Translate::Translate.new(locale, {:empty => true})
+      data = I18n::Translate::Processor::Properties.new(fname, tr).read
+    end
+  end
+end