gettext 2.2.1 → 2.3.0

data/bin/rxgettext

@@ -0,0 +1,24 @@
+#! /usr/bin/env ruby
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2012  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2005-2009  Masao Mutoh
+#
+# License: Ruby's or LGPL
+#
+# This library is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "gettext/tools/xgettext"
+
+GetText::Tools::XGetText.run(*ARGV)

data/doc/text/news.md

@@ -1,4 +1,64 @@
 # News
+## <a id="2-3-0">2.3.0</a>: 2012-08-28
+
+Various improvements, changes and fixes release.
+
+### Improvements
+
+  * Improved TextDomain#translate\_singluar\_message performance.
+    [Base idea is provided by @angelf]
+  * Added msginit command.
+  * [xgettext] Added command line options for package name, version,
+    copyright holder and msgid bugs address.[Github#8]
+    [Reported by Francesco Poli (wintermute) and 375gnu, and patch by 375gnu]
+  * [xgettext] Supported s\_ and ns\_ with parameter.
+  * [poparser] Reported warnings when fuzzy message is used.
+    [Reported by Michael Grosser]
+  * Used %{...} to check the availability of String#% with hash and
+    raise Error if this syntax isn't supported.
+  * Searched mo files under LC_MESSAGES/ directory.
+  * Updated documents for tools.
+
+### Changes
+
+  * Renamed the package name from "Ruby-GetText-Package" to "gettext".
+  * Renamed RGetText to XGetText, RMsgMerge to MsgMerge, RMsgFmt to MsgFmt.
+  * Renamed rgettext to rxgettext, rmsgmerge to msgmerge, rmsgfmt to msgfmt.
+  * Defined tools(XGetText, MsgMerge, MsgFmt) as Class under GetText::Tools
+    module.
+  * Removed shortcuts for tools in GetText module.
+    Please use GetText::Tools:XXX.run instead of GetText.xxx.
+  * Changed API of tools.
+    e.g.) Before: GetText.rsmgfmt(targetfile, output\_path)
+          Now: GetText::Tools::MsgFmt.run(targetfile, "-o", output\_path)
+  * [xgettext] Used relative path for source path.
+    This path appears in generated pot file.
+  * [xgettext] Returned the pot header instead of "" as the translation of
+    "" msgid.
+  * [poparser] Treated not translated msgid when parsing po file.
+    A translation of no translated msgid is msgid itself even now.
+  * [xgettext] Removed descriptions of ruby in information by "-v" option.
+
+### Fixes
+
+  * Included msgctxt when generating .po file. [Patch by 3dd13]
+  * Fixed a typo in msgmerge. [Patch by Yves-Eric Martin]
+  * [msgmerge] Followed PoParser API change.
+  * [ruby-parser] Reseted the last comment when po message is stored.[Github#6]
+    [Reported by 375gnu and Francesco Poli (wintermute), and Patch by 375gnu]
+  * [ruby-parser] Processed RubyToken::TkDSTRING too.[Github#6]
+    [Reported by 375gnu and Francesco Poli (wintermute), and Patch by 375gnu]
+  * [msgmerge] Fixed not to add fuzzy to header message.
+  * [msgmerge] Escaped backslash and "\n".
+
+### Thanks
+
+  * @angelf
+  * Francesco Poli (wintermute)
+  * 375gnu
+  * Michael Grosser
+  * 3dd13
+  * Yves-Eric Martin
 
 ## <a id="2-2-0">2.2.0</a>: 2012-03-11
 

data/gettext.gemspec

@@ -7,11 +7,11 @@ require "gettext/version"
 Gem::Specification.new do |s|
   s.name = "gettext"
   s.version = GetText::VERSION
-  s.summary = 'Ruby-GetText-Package is a libary and tools to localize messages.'
+  s.summary = 'Gettext is a pure Ruby libary and tools to localize messages.'
   s.description = <<-EOD
-Ruby-GetText-Package is a GNU GetText-like program for Ruby.
-The catalog file(po-file) is same format with GNU GetText.
-So you can use GNU GetText tools for maintaining.
+Gettext is a GNU gettext-like program for Ruby.
+The catalog file(po-file) is same format with GNU gettext.
+So you can use GNU gettext tools for maintaining.
   EOD
   s.authors = ["Kouhei Sutou", "Masao Mutoh"]
   s.email = ["kou@clear-code.com", "mutomasa at gmail.com"]
@@ -28,8 +28,11 @@ So you can use GNU GetText tools for maintaining.
   end
 
   s.add_runtime_dependency("locale")
+  s.add_development_dependency("rake")
   s.add_development_dependency("racc")
   s.add_development_dependency("yard")
+  s.add_development_dependency("redcarpet")
   s.add_development_dependency("test-unit")
   s.add_development_dependency("test-unit-notify")
+  s.add_development_dependency("test-unit-rr")
 end

data/lib/gettext.rb

@@ -127,7 +127,7 @@ module GetText
   # * msgid: the message id.
   # * Returns: localized text by msgid. If there are not binded mo-file, it will return msgid.
   def gettext(msgid)
-    TextDomainManager.translate_singluar_message(self, msgid)
+    TextDomainManager.translate_singular_message(self, msgid)
   end
 
   # call-seq:
@@ -144,7 +144,7 @@ module GetText
   #   <tt>Movie|Location -> Location</tt>
   # See: http://www.gnu.org/software/gettext/manual/html_mono/gettext.html#SEC151
   def sgettext(msgid, seperator = "|")
-    TextDomainManager.translate_singluar_message(self, msgid, seperator)
+    TextDomainManager.translate_singular_message(self, msgid, seperator)
   end
 
   # call-seq:
@@ -161,7 +161,7 @@ module GetText
   #   it returns msgid.
   # See: http://www.gnu.org/software/autoconf/manual/gettext/Contexts.html
   def pgettext(msgctxt, msgid)
-    TextDomainManager.translate_singluar_message(self, "#{msgctxt}\004#{msgid}", "\004")
+    TextDomainManager.translate_singular_message(self, "#{msgctxt}\004#{msgid}", "\004")
   end
 
   # call-seq:

data/lib/gettext/core_ext/string.rb

@@ -21,7 +21,8 @@ class String
   end
 
   begin
-    "%<key>" % {:key => "value"}
+    formatted = "%{key}" % {:key => "value"}
+    raise ArgumentError if formatted != "value"
   rescue ArgumentError
     alias :_old_format_m :% # :nodoc:
 

data/lib/gettext/runtime/locale_path.rb

@@ -56,9 +56,11 @@ module GetText
         load_path.map!{|v| v.match(/(.*?)(\/lib)*?$/); $1}
         load_path.each {|path|
           default_path_rules += [
-                                 "#{path}/data/locale/%{lang}/LC_MESSAGES/%{name}.mo",
-                                 "#{path}/data/locale/%{lang}/%{name}.mo",
-                                 "#{path}/locale/%{lang}/%{name}.mo"]
+            "#{path}/data/locale/%{lang}/LC_MESSAGES/%{name}.mo",
+            "#{path}/data/locale/%{lang}/%{name}.mo",
+            "#{path}/locale/%{lang}/LC_MESSAGES/%{name}.mo",
+            "#{path}/locale/%{lang}/%{name}.mo",
+          ]
         }
         # paths existed only.
         default_path_rules = default_path_rules.select{|path|
@@ -85,7 +87,7 @@ module GetText
       @locale_paths = {}
       path_rules.each do |rule|
         this_path_rules = rule % {:lang => "([^\/]+)", :name => name}
-        Dir.glob(rule %{:lang => "*", :name => name}).each do |path|
+        Dir.glob(rule % {:lang => "*", :name => name}).each do |path|
           if /#{this_path_rules}/ =~ path
             @locale_paths[$1] = path.untaint unless @locale_paths[$1]
           end

data/lib/gettext/runtime/textdomain.rb

@@ -67,8 +67,8 @@ module GetText
     # * lang: Locale::Tag::Simple's subclass.
     # * msgid: the original message.
     # * Returns: the translated string or nil.
-    def translate_singluar_message(lang, msgid)
-      return "" if msgid == "" or msgid.nil?
+    def translate_singular_message(lang, msgid)
+      return "" if msgid.nil?
 
       lang_key = lang.to_s
 
@@ -85,14 +85,19 @@ module GetText
       end
 
       msgstr = mofile[msgid]
-      if msgstr and (msgstr.size > 0)
-        msgstr
+      if not msgstr.nil?
+        if msgstr.empty?
+          nil
+        else
+          msgstr
+        end
       elsif msgid.include?("\000")
-        # Check "aaa\000bbb" and show warning but return the singluar part.
+        # Check "aaa\000bbb" and show warning but return the singular part.
         ret = nil
         msgid_single = msgid.split("\000")[0]
+        msgid_single_prefix_re = /^#{Regexp.quote(msgid_single)}\000/
         mofile.each{|key, val|
-          if key =~ /^#{Regexp.quote(msgid_single)}\000/
+          if key =~ msgid_single_prefix_re
             # Usually, this is not caused to make po-files from rgettext.
             warn %Q[Warning: n_("#{msgid_single}", "#{msgid.split("\000")[1]}") and n_("#{key.gsub(/\000/, '", "')}") are duplicated.]
             ret = val
@@ -102,8 +107,9 @@ module GetText
         ret
       else
         ret = nil
+        msgid_prefix_re = /^#{Regexp.quote(msgid)}\000/
         mofile.each{|key, val|
-          if key =~ /^#{Regexp.quote(msgid)}\000/
+          if key =~ msgid_prefix_re
             ret = val.split("\000")[0]
             break
           end
@@ -122,7 +128,7 @@ module GetText
     # * Returns: the translated string as an Array ([[msgstr1, msgstr2, ...], cond]) or nil.
     def translate_plural_message(lang, msgid, msgid_plural)   #:nodoc:
       key = msgid + "\000" + msgid_plural
-      msg = translate_singluar_message(lang, key)
+      msg = translate_singular_message(lang, key)
       ret = nil
       if ! msg
         ret = nil

data/lib/gettext/runtime/textdomain_manager.rb

@@ -95,14 +95,14 @@ module GetText
     # * div: separator or nil.
     # * Returns: the localized text by msgid. If there are no localized text,
     #   it returns a last part of msgid separeted "div".
-    def translate_singluar_message(klass, msgid, div = nil)
+    def translate_singular_message(klass, msgid, div = nil)
       klass = ClassInfo.normalize_class(klass)
       key = [Locale.current, klass, msgid, div].hash
       msg = @@singular_message_cache[key]
       return msg if msg and @@cached
       # Find messages from related classes.
       each_textdomains(klass) do |textdomain, lang|
-        msg = textdomain.translate_singluar_message(lang, msgid)
+        msg = textdomain.translate_singular_message(lang, msgid)
         break if msg
       end
 
@@ -116,7 +116,7 @@ module GetText
       @@singular_message_cache[key] = msg
     end
 
-    # This function is similar to the get_singluar_message function
+    # This function is similar to the get_singular_message function
     # as it finds the message catalogs in the same way.
     # But it takes two extra arguments for plural form.
     # The msgid parameter must contain the singular form of the string to be converted.

data/lib/gettext/task.rb

@@ -0,0 +1,203 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2012  Kouhei Sutou <kou@clear-code.com>
+#
+# License: Ruby's or LGPL
+#
+# This library is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "gettext/tools"
+
+module GetText
+  class Task
+    include GetText
+    include Rake::DSL
+
+    attr_accessor :locales, :po_base_directory, :mo_base_directory, :domain
+    attr_accessor :namespace_prefix, :files
+    def initialize(spec)
+      @spec = spec
+      @locales = []
+      @po_base_directory = "po"
+      @mo_base_directory = "."
+      @files = target_files
+      @domain = @spec.name
+      @namespace_prefix = nil
+      yield(self) if block_given?
+      @locales = detect_locales if @locales.empty?
+      raise("must set locales: #{inspect}") if @locales.empty?
+      define
+    end
+
+    private
+    def define
+      define_file_tasks
+      if namespace_prefix
+        namespace_recursive namespace_prefix do
+          define_named_tasks
+        end
+      else
+        define_named_tasks
+      end
+    end
+
+    def define_file_tasks
+      unless files.empty?
+        pot_dependencies = files.dup
+        unless File.exist?(po_base_directory)
+          directory po_base_directory
+          pot_dependencies << po_base_directory
+        end
+        file pot_file => pot_dependencies do
+          GetText::Tools::XGetText.run("--package-name", @spec.name,
+                                       "--package-version", @spec.version.to_s,
+                                       "--output", pot_file,
+                                       *files)
+        end
+      end
+
+      locales.each do |locale|
+        _po_file = po_file(locale)
+        unless files.empty?
+          po_dependencies = [pot_file]
+          _po_directory = po_directory(locale)
+          unless File.exist?(_po_directory)
+            directory _po_directory
+            po_dependencies << _po_directory
+          end
+          file _po_file => po_dependencies do
+            if File.exist?(_po_file)
+              GetText::Tools::MsgMerge.run(po_file(locale), pot_file,
+                                           "--output", _po_file)
+            else
+              GetText::Tools::MsgInit.run("--input", pot_file,
+                                          "--output", _po_file,
+                                          "--locale", locale.to_s)
+            end
+          end
+        end
+
+        mo_dependencies = [_po_file]
+        _mo_directory = mo_directory(locale)
+        unless File.exist?(_mo_directory)
+          directory _mo_directory
+          mo_dependencies << _mo_directory
+        end
+        _mo_file = mo_file(locale)
+        file _mo_file => mo_dependencies do
+          GetText::Tools::MsgFmt.run(_po_file, "--output", _mo_file)
+        end
+      end
+    end
+
+    def define_named_tasks
+      namespace :gettext do
+        namespace :pot do
+          desc "Create #{pot_file}"
+          task :create => pot_file
+        end
+
+        namespace :po do
+          update_tasks = []
+          @locales.each do |locale|
+            namespace locale do
+              desc "Update #{po_file(locale)}"
+              task :update => po_file(locale)
+              update_tasks << (current_scope + ["update"]).join(":")
+            end
+          end
+
+          desc "Update *.po"
+          task :update => update_tasks
+        end
+
+        namespace :mo do
+          update_tasks = []
+          @locales.each do |locale|
+            namespace locale do
+              desc "Update #{mo_file(locale)}"
+              task :update => mo_file(locale)
+              update_tasks << (current_scope + ["update"]).join(":")
+            end
+          end
+
+          desc "Update *.mo"
+          task :update => update_tasks
+        end
+      end
+
+      desc "Update *.mo"
+      task :gettext => (current_scope + ["gettext", "mo", "update"]).join(":")
+    end
+
+    def pot_file
+      File.join(po_base_directory, "#{domain}.pot")
+    end
+
+    def po_directory(locale)
+      File.join(po_base_directory, locale.to_s)
+    end
+
+    def po_file(locale)
+      File.join(po_directory(locale), "#{domain}.po")
+    end
+
+    def mo_directory(locale)
+      File.join(mo_base_directory, "locale", locale.to_s, "LC_MESSAGES")
+    end
+
+    def mo_file(locale)
+      File.join(mo_directory(locale), "#{domain}.mo")
+    end
+
+    def target_files
+      files = @spec.files.find_all do |file|
+        /\.(?:rb|erb|glade)/i =~ File.extname(file)
+      end
+      files += @spec.executables.collect do |executable|
+        "bin/#{executable}"
+      end
+      files
+    end
+
+    def detect_locales
+      locales = []
+      return locales unless File.exist?(po_base_directory)
+
+      Dir.open(po_base_directory) do |dir|
+        dir.each do |entry|
+          next unless /\A[a-z]{2}(?:_[A-Z]{2})?\z/ =~ entry
+          next unless File.directory?(File.join(dir.path, entry))
+          locales << entry
+        end
+      end
+      locales
+    end
+
+    def current_scope
+      Rake.application.current_scope
+    end
+
+    def namespace_recursive(namespace_spec, &block)
+      first, rest = namespace_spec.split(/:/, 2)
+      namespace first do
+        if rest.nil?
+          block.call
+        else
+          namespace_recursive(rest, &block)
+        end
+      end
+    end
+  end
+end