gettext 1.1.1 → 1.2.0

data/lib/gettext/string.rb

@@ -2,15 +2,37 @@
 =begin
   string.rb - Extension for String.
 
-  Copyright (C) 2005  Masao Mutoh
+  Copyright (C) 2005,2006 Masao Mutoh
  
   You may redistribute it and/or modify it under the same
   license terms as Ruby.
 =end
 
+# = Extension for String class.
+# String#% method which accept "named argument". The translator can know 
+# the meaning of the msgids using "named argument" instead of %s/%d style.
 class String
-  alias :_old_format_m :%
-    
+  alias :_old_format_m :% # :nodoc:
+
+  # call-seq:
+  #  %(arg)
+  #  %(hash)
+  #
+  # Format - Uses str as a format specification, and returns the result of applying it to arg. 
+  # If the format specification contains more than one substitution, then arg must be 
+  # an Array containing the values to be substituted. See Kernel::sprintf for details of the 
+  # format string. This is the default behavior of the String class.
+  # * arg: an Array or other class except Hash.
+  # * Returns: formatted String
+  #
+  #  (e.g.) "%s, %s" % ["Masao", "Mutoh"]
+  #
+  # Also you can use a Hash as the "named argument". This is recommanded way for Ruby-GetText
+  # because the translators can understand the meanings of the msgids easily.
+  # * hash: {:key1 => value1, :key2 => value2, ... }
+  # * Returns: formatted String
+  #
+  #  (e.g.) "%{firstname}, %{familyname}" % {:firstname => "Masao", :familyname => "Mutoh"}
   def %(args)
     if args.kind_of?(Hash)
       ret = dup

data/lib/gettext/textdomain.rb

@@ -1,7 +1,7 @@
 =begin
   textdomain.rb - GetText::Textdomain
 
-  Copyright (C) 2001-2005  Masao Mutoh
+  Copyright (C) 2001-2006  Masao Mutoh
   Copyright (C) 2001-2003  Masahiro Sakai
 
       Masahiro Sakai    <s01397ms@sfc.keio.ac.jp>
@@ -10,94 +10,103 @@
   You may redistribute it and/or modify it under the same
   license terms as Ruby.
 
-  $Id: textdomain.rb,v 1.8 2005/12/23 04:00:52 mutoh Exp $
+  $Id: textdomain.rb,v 1.14 2006/02/23 14:53:59 mutoh Exp $
 =end
 
+require 'gettext/string'
 require 'rbconfig'
 
 module GetText
+  # GetText::TextDomain class manages mo-files of a textdomain. 
+  # 
+  # Usually, you don't need to use this class directly.
+  #
+  # Notice: This class is unstable. APIs will be changed.
   class TextDomain
 
-    GEM_PATH_RE = /(.*)\/lib$/
-    LOCALE_RE = /^([A-Za-z]+)(_[A-Za-z]+)?(\.\S+)?((?:@[^@]*)*)/
+    GEM_PATH_RE = /(.*)\/lib$/  # :nodoc:
 
-    attr_reader :locales
+    attr_reader :current_locale
+    attr_reader :current_mo
 
-    DEFAULT_LOCALE_DIRS = [
-      "#{Config::CONFIG['datadir']}/locale/%s/LC_MESSAGES/%s.mo",
-      "#{Config::CONFIG['prefix']}/share/locale/%s/LC_MESSAGES/%s.mo",
-      "#{Config::CONFIG['prefix']}/local/share/locale/%s/LC_MESSAGES/%s.mo"
+    # The default locale paths.
+    DEFAULT_LOCALE_PATHS = [
+      "#{Config::CONFIG['datadir']}/locale/%{locale}/LC_MESSAGES/%{name}.mo",
+      "#{Config::CONFIG['prefix']}/share/locale/%{locale}/LC_MESSAGES/%{name}.mo",
+      "#{Config::CONFIG['prefix']}/local/share/locale/%{locale}/LC_MESSAGES/%{name}.mo"
     ].uniq
 
-    def initialize(name, path, locale, charset)
-      @name, @path = name, path
+    # Add default locale path. Usually you should use GetText.add_default_locale_path instead.
+    # * path: a new locale path. (e.g.) "/usr/share/locale/%{locale}/LC_MESSAGES/%{name}.mo"
+    #    ('locale' => "ja_JP", 'name' => "textdomain")
+    # * Returns: the new DEFAULT_LOCALE_PATHS
+    def self.add_default_locale_path(path)
+      DEFAULT_LOCALE_PATHS << path
+    end
+
+    # Creates a new GetText::TextDomain.
+    # * name: the textdomain name.
+    # * topdir: the top directory of mo files or nil.
+    # * locale: the Locale::Object or nil.
+    # * Returns: a newly created GetText::TextDomain object.
+    def initialize(name, topdir = nil, locale = nil)
+      @name, @topdir = name, topdir
       @search_files = Array.new
 
-      @locale_dirs = []
+      @locale_paths = []
       if ENV["GETTEXT_PATH"]
         ENV["GETTEXT_PATH"].split(/,/).each {|i| 
-	  @locale_dirs += ["#{i}/%s/LC_MESSAGES/%s.mo", "#{i}/%s/%s.mo"]
+	  @locale_paths += ["#{i}/%{locale}/LC_MESSAGES/%{name}.mo", "#{i}/%{locale}/%{name}.mo"]
 	}
-      elsif path
-        @locale_dirs += ["#{path}/%s/LC_MESSAGES/%s.mo", "#{path}/%s/%s.mo"]
+      elsif @topdir
+        @locale_paths += ["#{@topdir}/%{locale}/LC_MESSAGES/%{name}.mo", "#{@topdir}/%{locale}/%{name}.mo"]
       end
 
-      unless path
-	@locale_dirs += DEFAULT_LOCALE_DIRS
+      unless @topdir
+	@locale_paths += DEFAULT_LOCALE_PATHS
 	
 	if defined? Gem
 	  $:.each do |path|
 	    if GEM_PATH_RE =~ path
-	      @locale_dirs += [
-		"#{$1}/data/locale/%s/LC_MESSAGES/%s.mo", 
-		"#{$1}/data/locale/%s/%s.mo", 
-		"#{$1}/locale/%s/%s.mo"]
+	      @locale_paths += [
+		"#{$1}/data/locale/%{locale}/LC_MESSAGES/%{name}.mo", 
+		"#{$1}/data/locale/%{locale}/%{name}.mo", 
+		"#{$1}/locale/%{locale}/%{name}.mo"]
 	    end
 	  end
 	end
       end
    
       @mofiles = Hash.new
-      set_charset(charset, false)
-      set_locale(locale, false)
-      load_mo
-    
-      $stderr.puts "Search path:#{@locale_dirs.inspect}" if $DEBUG
+      set_locale(locale)
     end
     
-    def set_locale(locale, reload = true)
-      locale = "C" unless locale
-      $stderr.puts "locale:#{locale}" if $DEBUG
-      @locales = []
-      matched = LOCALE_RE.match(locale)
-      if matched and matched.size > 1
-        matched = matched.to_a
-        matched.shift
-        while not matched.empty?
-          @locales.push(matched.join(''))
-          matched.pop
-        end
-        @locales.uniq!
-      else
-        @locales.push(locale)
-      end
-      load_mo(false) if reload
+    # Sets a new Locale::Object.
+    # * locale: a Locale::Object
+    # * reload: true if the mo-file is reloaded forcely
+    # * Returns: self
+    def set_locale(locale, reload = false)
+      @current_locale = locale
+      load_mo(reload)
+      self
     end
-    
+
+    # Gets the translated string.
+    # * msgid: the original message.
+    # * Returns: the translated string.
     def gettext(msgid)
-      if @mo
-	if @mo[msgid]
-	  result = @mo[msgid].size > 0 ? @mo[msgid] : msgid
-	else
-	  result = msgid
-	end
+      if @current_mo and @current_mo[msgid] and (@current_mo[msgid].size > 0)
+	@current_mo[msgid]
       else
-	no_mo_file if $DEBUG
-        result = msgid
+        msgid
       end
-      result
     end
 
+    # Gets the translated string.
+    # * msgid: the original message(single).
+    # * msgid: the original message(plural).
+    # * n: the number
+    # * Returns: the translated string.
     def ngettext(msgid, msgid_plural, n)
       key = msgid + "\000" + msgid_plural
       msg = gettext(key)
@@ -105,8 +114,8 @@ module GetText
 	msg = n == 1 ? msgid : msgid_plural
       elsif msg.include?("\000")
         ary = msg.split("\000")
-        if @mo
-          plural = eval(@mo.plural)
+        if @current_mo
+          plural = eval(@current_mo.plural)
           if plural.kind_of?(Numeric)
             msg = ary[plural]
           else
@@ -119,53 +128,43 @@ module GetText
       msg
     end
 
-    def no_mo_file
-      $stderr.puts "\nMO file is not found in"
-      @search_files.each do |fname|
-	$stderr.puts "\t#{fname}"
-      end
-    end
-
-    def same_property?(name, path, locale, charset)
-      @name == name and @path == path and @locales.include?(locale) and @charset == charset
+    # Compare this object has the same name, topdir and locale.
+    # * name: the textdomain name
+    # * topdir: the top directory of mo files or nil.
+    # * locale: the Locale::Object or nil.
+    # * Returns: true if this object has all of the same name, topdir and locale. 
+    def same_property?(name, topdir, locale)
+      @name == name and @topdir == topdir and @current_locale == locale
     end
     
-    def set_charset(charset, reload = true)
-      if charset and charset != ""
-        @charset = charset
-      else
-        @charset = ENV["OUTPUT_CHARSET"] ? ENV["OUTPUT_CHARSET"] : Locale.codeset
-      end
-      $stderr.puts "GetText::TextDomain#set_charset: charset = #{charset}" if $DEBUG
-      load_mo(false) if reload
-    end
-
-    attr_reader :charset
-
-    def load_mo(cache = true)
-      @mo = nil
-      if cache 
-	@mo = @mofiles[@locales[0]]
-	if @mo
-	  return @mo == :empty ? nil : @mo
+    private
+    def load_mo(reload = false)
+      @current_mo = nil
+      return @current_mo unless @current_locale
+      unless reload
+	@current_mo = @mofiles[@current_locale]
+	if @current_mo
+	  @current_mo = (@current_mo == :empty) ? nil : @current_mo
+	  return @current_mo
 	end
       end
-      @locale_dirs.each do |dir|
-	@locales.each{|locale|
-	  fname = dir % [locale, @name]
+      locales = [@current_locale.orig_str, @current_locale.to_posix, @current_locale.language]
+      @locale_paths.each do |dir|
+	locales.each{|locale|
+	  fname = dir % {:locale => locale, :name => @name}
 	  @search_files << fname
 	  if File.exist?(fname)
 	    $stderr.puts "GetText::TextDomain#load_mo: mo file is #{fname}" if $DEBUG
-	    @mo = MOFile.open(fname, @charset)
-	    @mofiles[@locales[0]] = @mo
+	    @current_mo = MOFile.open(fname, @current_locale.charset)
+	    @mofiles[@current_locale] = @current_mo
 	    break
 	  end
 	}
       end
-      unless @mo
-	@mofiles[@locales[0]] = :empty
+      unless @current_mo
+	@mofiles[@current_locale] = :empty
       end
-      @mo
+      @current_mo
     end
   end
 end

data/lib/gettext/utils.rb

@@ -13,7 +13,28 @@ require 'fileutils'
 
 module GetText
   module_function
-  def msgmerge(defpo, refpo, app_version)
+
+  # Merges two Uniforum style .po files together. 
+  #
+  # *Note* "msgmerge" tool is included in GNU GetText. So you need to install GNU GetText. 
+  #
+  # The def.po file is an existing PO file with translations which will be taken 
+  # over to the newly created file as long as they still match; comments will be preserved,
+  # but extracted comments and file positions will be discarded. 
+  #
+  # The ref.pot file is the last created PO file with up-to-date source references but
+  # old translations, or a PO Template file (generally created by rgettext);
+  # any translations or comments in the file will be discarded, however dot
+  # comments and file positions will be preserved.  Where an exact match
+  # cannot be found, fuzzy matching is used to produce better results.
+  #
+  # Usually you don't need to call this function directly. Use GetText.update_pofiles instead.
+  #
+  # * defpo: a po-file. translations referring to old sources
+  # * refpo: a po-file. references to new sources
+  # * app_version: the application information which appears "Project-Id-Version: #{app_version}" in the pot/po-files.
+  # * Returns: self 
+  def msgmerge(defpo, refpo, app_version) 
     $stderr.puts defpo
     cmd = ENV["MSGMERGE_PATH"]
     cmd ||= "msgmerge"
@@ -30,9 +51,10 @@ module GetText
     File.open(defpo, "w") do |out| 
       out.write(cont)
     end
+    self
   end
 
-  def msgmerge_all(textdomain, app_version, po_root = "po", refpot = "tmp.pot")
+  def msgmerge_all(textdomain, app_version, po_root = "po", refpot = "tmp.pot") # :nodoc:
     FileUtils.mkdir_p(po_root) unless FileTest.exist? po_root
     msgmerge("#{po_root}/#{textdomain}.pot", refpot, app_version)
     
@@ -42,7 +64,45 @@ module GetText
     }
   end
 
-  # updatepo("myapp", Dir.glob("lib/*.rb"), "myapp 1.0.0")
+  # Creates mo-files using #{po_root}/#{lang}/*.po an put them to 
+  # #{targetdir}/#{targetpath_rule}/. 
+  #
+  # This is a convenience function of GetText.rmsgfmt for plural target files. 
+  # * verbose: true if verbose mode, otherwise false
+  # * po_root: the root directory of po-files.
+  # * targetdir: the target root directory where the mo-files are stored.
+  # * targetpath_rule: the target directory for each mo-files. "%s" becomes "#{lang}" under po_root.
+  def create_mofiles(verbose = false, 
+		     podir = "./po", targetdir = "./data/locale", 
+		     targetpath_rule = "%s/LC_MESSAGES") 
+
+    modir = File.join(targetdir, targetpath_rule)
+    Dir.glob(File.join(podir, "*/*.po")) do |file|
+      lang, basename = /\/([^\/]+?)\/(.*)\.po/.match(file[podir.size..-1]).to_a[1,2]
+      outdir = modir % lang
+      FileUtils.mkdir_p(outdir) unless File.directory?(outdir)
+      rmsgfmt(file, File.join(outdir, "#{basename}.mo"))
+      if verbose
+	$stderr.puts %Q[#{file} -> #{File.join(outdir, "#{basename}.mo")}]
+      end
+    end
+  end
+
+
+  # At first, this creates the #{po_root}/#{domainname}.pot file using GetText.rgettext.
+  # Since 2nd time, this updates(merges) the #{po_root}/#{domainname}.pot and all of the 
+  # #{po_root}/#{lang}/#{domainname}.po files under "po_root" using "msgmerge". 
+  #
+  # *Note* "msgmerge" tool is included in GNU GetText. So you need to install GNU GetText. 
+  #
+  # See <HOWTO maintain po/mo files(http://www.yotabanana.com/hiki/ruby-gettext-howto-manage.html)> for more detals.
+  # * domainname: the textdomain name.
+  # * targetfiles: An Array of target files or nil (See GetText.rgettext for more details).
+  # * app_version: the application information which appears "Project-Id-Version: #{app_version}" in the pot/po-files.
+  # * po_root: the root directory of po-files.
+  # * refpot: set the temporary file name. You shouldn't use this(It will be removed).
+  #
+  #  (e.g.) GetText.update_pofiles("myapp", Dir.glob("lib/*.rb"), "myapp 1.0.0")
   def update_pofiles(textdomain, files, app_version, po_root = "po", refpot = "tmp.pot")
     rgettext(files, refpot)
     msgmerge_all(textdomain, app_version, po_root, refpot)

data/lib/gettext/version.rb

@@ -2,11 +2,11 @@
 =begin
   version - version information of Ruby-GetText-Package
 
-  Copyright (C) 2005,2006  Masao Mutoh
+  Copyright (C) 2005,2006 Masao Mutoh
  
   You may redistribute it and/or modify it under the same
   license terms as Ruby.
 =end
 module GetText
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

data/pkg/ruby-gettext-package-1.2.0/ext/gettext/extconf.rb

@@ -0,0 +1,20 @@
+=begin
+  extconf.rb
+
+  Copyright (C) 2002-2006 Masao Mutoh <mutoh@highway.ne.jp>
+ 
+  You may redistribute it and/or modify it under the same
+  license terms as Ruby.
+
+ $Id: extconf.rb,v 1.1 2006/02/07 00:24:45 mutoh Exp $
+=end
+
+require 'mkmf'
+
+if RUBY_PLATFORM =~ /cygwin|mingw|mswin32|bccwin32/
+  have_header 'windows.h'
+else
+  have_func 'setlocale'
+  have_func 'nl_langinfo'
+end
+create_makefile 'locale_system'

data/po/cs/rails.po

@@ -8,8 +8,8 @@
 #
 msgid ""
 msgstr ""
-"Project-Id-Version: ruby-gettext 1.1.0\n"
-"POT-Creation-Date: 2005-12-20 03:03+0900\n"
+"Project-Id-Version: ruby-gettext 1.2.0\n"
+"POT-Creation-Date: 2006-02-23 00:44+0900\n"
 "PO-Revision-Date: 2005-12-17 21:43+0100\n"
 "Last-Translator: Karel Miarka <kajism@yahoo.com>\n"
 "Language-Team: Czech\n"
@@ -20,64 +20,64 @@ msgstr ""
 "10<=4 && (n%100<10 || n%100>=20) ? 1 : 2);\n"
 "X-Poedit-Language: Czech\n"
 
-#: lib/gettext/rails.rb:100
+#: lib/gettext/rails.rb:117
+msgid "%{num} error prohibited this %{record} from being saved"
+msgid_plural "%{num} errors prohibited this %{record} from being saved"
+msgstr[0] "%{num} chyba znemožnila uložení záznamu %{record} "
+msgstr[1] "%{num} chyby znemožnily uložení záznamu %{record} "
+msgstr[2] "%{num} chyb znemožnilo uložení záznamu %{record} "
+
+#: lib/gettext/rails.rb:123
+msgid "There was a problem with the following field:"
+msgid_plural "There were problems with the following fields:"
+msgstr[0] "Problémy jsou s následujícím polem:"
+msgstr[1] "Problémy jsou s následujícími poli:"
+msgstr[2] "Problémy jsou s následujícími poli:"
+
+#: lib/gettext/rails.rb:135
 msgid "%{fn} is not included in the list"
 msgstr "%{fn} není obsaženo v seznamu možností"
 
-#: lib/gettext/rails.rb:101
+#: lib/gettext/rails.rb:136
 msgid "%{fn} is reserved"
 msgstr "%{fn} je rezervováno a nemůže být zvoleno"
 
-#: lib/gettext/rails.rb:102
+#: lib/gettext/rails.rb:137
 msgid "%{fn} is invalid"
 msgstr "%{fn} je chybné"
 
-#: lib/gettext/rails.rb:103
+#: lib/gettext/rails.rb:138
 msgid "%{fn} doesn't match confirmation"
 msgstr "%{fn} není shodné s potvrzením"
 
-#: lib/gettext/rails.rb:104
+#: lib/gettext/rails.rb:139
 msgid "%{fn} must be accepted"
 msgstr "%{fn} musí být zaškrtnuto"
 
-#: lib/gettext/rails.rb:105
+#: lib/gettext/rails.rb:140
 msgid "%{fn} can't be empty"
 msgstr "%{fn} musí být vyplněno"
 
-#: lib/gettext/rails.rb:106
+#: lib/gettext/rails.rb:141
 msgid "%{fn} can't be blank"
 msgstr "%{fn} musí být vyplněno"
 
-#: lib/gettext/rails.rb:107
+#: lib/gettext/rails.rb:142
 msgid "%{fn} is too long (max is %d characters)"
 msgstr "%{fn} je příliš dlouhé (maximum je %d znaků)"
 
-#: lib/gettext/rails.rb:108
+#: lib/gettext/rails.rb:143
 msgid "%{fn} is too short (min is %d characters)"
 msgstr "%{fn} je příliš krátké (minimum je %d znaků)"
 
-#: lib/gettext/rails.rb:109
+#: lib/gettext/rails.rb:144
 msgid "%{fn} is the wrong length (should be %d characters)"
 msgstr "%{fn} má nesprávnou délku (musí mít %d znaků)"
 
-#: lib/gettext/rails.rb:110
+#: lib/gettext/rails.rb:145
 msgid "%{fn} has already been taken"
 msgstr "%{fn} je již použito"
 
-#: lib/gettext/rails.rb:111
+#: lib/gettext/rails.rb:146
 msgid "%{fn} is not a number"
 msgstr "%{fn} není správné číslo"
-
-#: lib/gettext/rails.rb:176
-msgid "%{num} error prohibited this %{record} from being saved"
-msgid_plural "%{num} errors prohibited this %{record} from being saved"
-msgstr[0] "%{num} chyba znemožnila uložení záznamu %{record} "
-msgstr[1] "%{num} chyby znemožnily uložení záznamu %{record} "
-msgstr[2] "%{num} chyb znemožnilo uložení záznamu %{record} "
-
-#: lib/gettext/rails.rb:179
-msgid "There were problems with the following field:"
-msgid_plural "There were problems with the following fields:"
-msgstr[0] "Problémy jsou s následujícím polem:"
-msgstr[1] "Problémy jsou s následujícími poli:"
-msgstr[2] "Problémy jsou s následujícími poli:"