gettext 2.2.1 → 2.3.0

data/lib/gettext/tools.rb

@@ -1,23 +1,34 @@
-# encoding: utf-8
-
-=begin
-  tools.rb - Utility functions
-
-  Copyright (C) 2005-2008 Masao Mutoh
-
-  You may redistribute it and/or modify it under the same
-  license terms as Ruby or LGPL.
-=end
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2012  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2005-2008  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 'rbconfig'
 if /mingw|mswin|mswin32/ =~ RUBY_PLATFORM
   ENV['PATH'] = %w(bin lib).collect{|dir|
-    "#{Config::CONFIG["prefix"]}\\lib\\GTK\\#{dir};"
+    "#{::RbConfig::CONFIG["prefix"]}\\lib\\GTK\\#{dir};"
   }.join('') + ENV['PATH']
 end
 
-require 'gettext/tools/rgettext'
-require 'gettext/tools/rmsgfmt'
+require 'gettext/tools/xgettext'
+require 'gettext/tools/msgfmt'
+require 'gettext/tools/msginit'
+require 'gettext/tools/msgmerge'
 require 'gettext/runtime/mofile'
 require 'fileutils'
 
@@ -45,7 +56,7 @@ module GetText
   # 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);
+  # old translations, or a PO Template file (generally created by rxgettext);
   # 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.
@@ -95,21 +106,23 @@ module GetText
       mo_file = mo_file_from_po_file(po_file,options)
       $stderr.print %Q[#{po_file} -> #{mo_file} ... ] if options[:verbose]
       FileUtils.mkdir_p(File.dirname(mo_file))
-      rmsgfmt(po_file, mo_file)
+      Tools::MsgFmt.run(po_file, "-o", mo_file)
       $stderr.puts "Done." if options[:verbose]
     end
   end
 
 
-  # At first, this creates the #{po_root}/#{domainname}.pot file using GetText.rgettext.
-  # In the second step, this updates(merges) the #{po_root}/#{domainname}.pot and all of the
-  # #{po_root}/#{lang}/#{domainname}.po files under "po_root" using "msgmerge".
+  # At first, this creates the #{po_root}/#{domainname}.pot file using
+  # GetText::XGetText.run.  In the second step, 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, that should be parsed for messages (See GetText.rgettext for more details).
+  # * targetfiles: An Array of target files, that should be parsed for messages (See GetText::XGetText.run for more details).
   # * app_version: the application information which appears "Project-Id-Version: #{app_version}" in the pot/po-files.
   # * options: a hash with following possible settings
   #     :lang    - update files only for one language - the language specified by this option
@@ -125,7 +138,7 @@ module GetText
 
     #write found messages to tmp.pot
     temp_pot = "tmp.pot"
-    rgettext(files, temp_pot)
+    Tools::XGetText.run("-o", temp_pot, *files)
 
     #merge tmp.pot and existing pot
     po_root = options.delete(:po_root) || "po"
@@ -191,7 +204,3 @@ module GetText
     File.join(mo_dir, "#{textdomain}.mo")
   end
 end
-
-if __FILE__ == $0
-  GetText.update_pofiles("foo", ARGV, "foo 1.1.0")
-end

data/lib/gettext/tools/msgfmt.rb

@@ -0,0 +1,104 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2012  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2012  Haruka Yoshihara <yoshihara@clear-code.com>
+# Copyright (C) 2003-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 "optparse"
+require "fileutils"
+require "gettext"
+require "gettext/tools/poparser"
+
+module GetText
+  module Tools
+    class MsgFmt  #:nodoc:
+      # Create a mo-file from a target file(po-file).
+      # You must specify a path of a target file in arguments.
+      # If a path of a mo-file is not specified in arguments, a mo-file is
+      # created as "messages.mo" in the current directory.
+      # @param [Array<String>] arguments arguments for rmsgfmt.
+      # @return [void]
+      class << self
+        def run(*arguments)
+          new.run(*arguments)
+        end
+      end
+
+      include GetText
+
+      bindtextdomain("rgettext")
+
+      def initialize
+        @input_file = nil
+        @output_file = nil
+      end
+
+      def run(*options) # :nodoc:
+        initialize_arguments(*options)
+
+        parser = PoParser.new
+        data = MoFile.new
+
+        parser.parse_file(@input_file, data)
+        data.save_to_file(@output_file)
+      end
+
+      def initialize_arguments(*options) # :nodoc:
+        input_file, output_file = parse_commandline_options(*options)
+
+        if input_file.nil?
+          raise(ArgumentError, _("no input files specified."))
+        end
+
+        if output_file.nil?
+          output_file = "messages.mo"
+        end
+
+        @input_file = input_file
+        @output_file = output_file
+      end
+
+      def parse_commandline_options(*options)
+        output_file = nil
+
+        parser = OptionParser.new
+        parser.banner = _("Usage: %s input.po [-o output.mo]" % $0)
+        parser.separator("")
+        description = _("Generate binary message catalog from textual " +
+                          "translation description.")
+        parser.separator(description)
+        parser.separator("")
+        parser.separator(_("Specific options:"))
+
+        parser.on("-o", "--output=FILE",
+                _("write output to specified file")) do |out|
+          output_file = out
+        end
+
+        parser.on_tail("--version", _("display version information and exit")) do
+          puts(VERSION)
+          exit(true)
+        end
+        parser.parse!(options)
+
+        input_file = options[0]
+        [input_file, output_file]
+      end
+    end
+  end
+end

data/lib/gettext/tools/msginit.rb

@@ -0,0 +1,363 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2012  Haruka Yoshihara <yoshihara@clear-code.com>
+# 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"
+require "gettext/tools/poparser"
+require "gettext/tools/msgmerge"
+require "locale/info"
+require "optparse"
+
+module GetText
+  module Tools
+    class MsgInit
+      class Error < StandardError
+      end
+
+      class ArgumentError < Error
+      end
+
+      class ValidationError < Error
+      end
+
+      class << self
+        # Create a new .po file from initializing .pot file with user's
+        # environment and input.
+        # @param [Array<String>] arguments arguments for rmsginit.
+        # @return [void]
+        def run(*arguments)
+          new.run(*arguments)
+        end
+      end
+
+      include GetText
+
+      bindtextdomain("rgettext")
+
+      def initialize #:nodoc:
+        @input_file = nil
+        @output_file = nil
+        @locale = nil
+        @language = nil
+        @entry = nil
+        @comment = nil
+        @translator = nil
+      end
+
+      # Create .po file from .pot file, user's inputs and metadata.
+      # @param [Array] arguments the list of arguments for rmsginit
+      def run(*arguments)
+        parse_arguments(*arguments)
+        validate
+
+        parser = PoParser.new
+        parser.ignore_fuzzy = false
+        pot = parser.parse_file(@input_file,
+                                GetText::Tools::MsgMerge::PoData.new)
+        po = replace_pot_header(pot)
+
+        File.open(@output_file, "w") do |f|
+          f.puts(po.generate_po)
+        end
+      end
+
+      private
+      VERSION = GetText::VERSION
+
+      def parse_arguments(*arguments) #:nodoc:
+        parser = OptionParser.new
+        description = _("Create a new .po file from initializing .pot " +
+                          "file with user's environment and input.")
+        parser.separator(description)
+        parser.separator("")
+        parser.separator(_("Specific options:"))
+
+        input_description = _("Use INPUT as a .pot file. If INPUT is not " +
+                                "specified, INPUT is a .pot file existing " +
+                                "the current directory.")
+        parser.on("-i", "--input=FILE", input_description) do |input|
+          @input_file = input
+        end
+
+        output_description = _("Use OUTPUT as a created .po file. If OUTPUT " +
+                                 "is not specified, OUTPUT depend on LOCALE " +
+                                 "or the current locale on your environment.")
+        parser.on("-o", "--output=OUTPUT", output_description) do |output|
+          @output_file = output
+        end
+
+        locale_description = _("Use LOCALE as target locale. If LOCALE is " +
+                                 "not specified, LOCALE is the current " +
+                                 "locale on your environment.")
+        parser.on("-l", "--locale=LOCALE", locale_description) do |loc|
+          @locale = loc
+        end
+
+        parser.on("-h", "--help", _("Dispray this help and exit")) do
+          puts(parser.help)
+          exit(true)
+        end
+
+        version_description = _("Display version and exit")
+        parser.on_tail("-v", "--version", version_description) do
+          puts(VERSION)
+          exit(true)
+        end
+
+        begin
+          parser.parse!(arguments)
+        rescue OptionParser::ParseError
+          raise(ArgumentError, $!.message)
+        end
+      end
+
+      def validate
+        if @input_file.nil?
+          @input_file = Dir.glob("./*.pot").first
+          if @input_file.nil?
+            raise(ValidationError,
+                  _(".pot file does not exist in the current directory."))
+          end
+        else
+          unless File.exist?(@input_file)
+            raise(ValidationError,
+                  _("file #{@input_file} does not exist."))
+          end
+        end
+
+        if @locale.nil?
+          language_tag = Locale.current
+        else
+          language_tag = Locale::Tag.parse(@locale)
+        end
+
+        unless valid_locale?(language_tag)
+          raise(ValidationError,
+                _("Locale '#{language_tag}' is invalid. " +
+                    "Please check if your specified locale is usable."))
+        end
+        @locale = language_tag.to_simple.to_s
+        @language = language_tag.language
+
+        @output_file ||= "#{@locale}.po"
+        if File.exist?(@output_file)
+          raise(ValidationError,
+                _("file #{@output_file} has already existed."))
+        end
+      end
+
+      def valid_locale?(language_tag)
+        return false if language_tag.instance_of?(Locale::Tag::Irregular)
+
+        Locale::Info.language_code?(language_tag.language)
+      end
+
+      def replace_pot_header(pot) #:nodoc:
+        @entry = pot[""]
+        @comment = pot.comment("")
+        @translator = translator_info
+
+        replace_entry
+        replace_comment
+
+        pot[""] = @entry.chomp
+        pot.set_comment("", @comment)
+        pot
+      end
+
+      def translator_info
+        full_name = translator_full_name
+        mail = translator_mail
+        if not full_name.nil? and not mail.nil?
+          "#{full_name} <#{mail}>"
+        else
+          nil
+        end
+      end
+
+      def translator_full_name
+        read_translator_full_name
+      end
+
+      def read_translator_full_name #:nodoc:
+        prompt(_("Please enter your full name"), guess_full_name)
+      end
+
+      def guess_full_name
+        ENV["USERNAME"]
+      end
+
+      def translator_mail
+        read_translator_mail
+      end
+
+      def read_translator_mail #:nodoc:
+        prompt(_("Please enter your email address"), guess_mail)
+      end
+
+      def guess_mail
+        ENV["EMAIL"]
+      end
+
+      def prompt(message, default)
+        print(message)
+        print(" [#{default}]") if default
+        print(": ")
+
+        user_input = $stdin.gets.chomp
+        if user_input.empty?
+          default
+        else
+          user_input
+        end
+      end
+
+      def replace_entry
+        replace_last_translator
+        replace_pot_revision_date
+        replace_language
+        replace_plural_forms
+      end
+
+      def replace_comment
+        replace_description
+        replace_first_author
+        replace_copyright_year
+        @comment = @comment.gsub(/#, fuzzy/, "")
+      end
+
+      EMAIL = "EMAIL@ADDRESS"
+      FIRST_AUTHOR_KEY = /^(\s*#\s*) FIRST AUTHOR <#{EMAIL}>, (\d+\.)$/
+
+      def replace_last_translator #:nodoc:
+        unless @translator.nil?
+          @entry = @entry.gsub(LAST_TRANSLATOR_KEY, "\\1 #{@translator}")
+        end
+      end
+
+      POT_REVISION_DATE_KEY = /^(PO-Revision-Date:).+/
+
+      def replace_pot_revision_date #:nodoc:
+        date = Time.now
+        revision_date = date.strftime("%Y-%m-%d %H:%M%z")
+
+        @entry = @entry.gsub(POT_REVISION_DATE_KEY,
+                             "\\1 #{revision_date}")
+      end
+
+      LANGUAGE_KEY = /^(Language:).+/
+      LANGUAGE_TEAM_KEY = /^(Language-Team:).+/
+
+      def replace_language #:nodoc:
+        language_name = Locale::Info.get_language(@language).name
+        @entry = @entry.gsub(LANGUAGE_KEY, "\\1 #{@locale}")
+        @entry = @entry.gsub(LANGUAGE_TEAM_KEY, "\\1 #{language_name}")
+      end
+
+      PLURAL_FORMS =
+        /^(Plural-Forms:) nplurals=INTEGER; plural=EXPRESSION;$/
+
+      def replace_plural_forms #:nodoc:
+        @entry = @entry.gsub(PLURAL_FORMS, "\\1 #{plural_forms(@language)}")
+      end
+
+      def plural_forms(language) #:nodoc:
+        case language
+        when "ja", "vi", "ko"
+          nplural = "1"
+          plural_expression = "0"
+        when "en", "de", "nl", "sv", "da", "no", "fo", "es", "pt",
+             "it", "bg", "el", "fi", "et", "he", "eo", "hu", "tr"
+          nplural = "2"
+          plural_expression = "n != 1"
+        when "pt_BR", "fr"
+          nplural = "2"
+          plural_expression = "n>1"
+        when "lv"
+          nplural = "3"
+          plural_expression = "n%10==1 && n%100!=11 ? 0 : n != 0 ? 1 : 2"
+        when "ga"
+          nplural = "3"
+          plural_expression = "n==1 ? 0 : n==2 ? 1 : 2"
+        when "ro"
+          nplural = "3"
+          plural_expression = "n==1 ? 0 : " +
+                                "(n==0 || (n%100 > 0 && n%100 < 20)) ? 1 : 2"
+        when "lt"
+          nplural = "3"
+          plural_expression = "n%10==1 && n%100!=11 ? 0 : " +
+                                "n%10>=2 && (n%100<10 || n%100>=20) ? 1 : 2"
+        when "ru", "uk", "sr", "hr"
+          nplural = "3"
+          plural_expression = "n%10==1 && n%100!=11 ? 0 : n%10>=2 && " +
+                                "n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2"
+        when "cs", "sk"
+          nplural = "3"
+          plural_expression = "(n==1) ? 0 : (n>=2 && n<=4) ? 1 : 2"
+        when "pl"
+          nplural = "3"
+          plural_expression = "n==1 ? 0 : n%10>=2 && " +
+                                "n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2"
+        when "sl"
+          nplural = "4"
+          plural_expression = "n%100==1 ? 0 : n%100==2 ? 1 : n%100==3 " +
+                                "|| n%100==4 ? 2 : 3"
+        else
+          nplural = nil
+          plural_expression = nil
+        end
+
+        "nplurals=#{nplural}; plural=#{plural_expression};"
+      end
+
+      DESCRIPTION_TITLE = /^(\s*#\s*) SOME DESCRIPTIVE TITLE\.$/
+
+      def replace_description #:nodoc:
+        language_name = Locale::Info.get_language(@language).name
+        package_name = ""
+        @entry.gsub(/Project-Id-Version: (.+?) .+/) do
+          package_name = $1
+        end
+        description = "#{language_name} translations " +
+                        "for #{package_name} package."
+        @comment = @comment.gsub(DESCRIPTION_TITLE, "\\1 #{description}")
+      end
+
+      YEAR_KEY = /^(\s*#\s* FIRST AUTHOR <#{EMAIL}>,) YEAR\.$/
+      LAST_TRANSLATOR_KEY = /^(Last-Translator:) FULL NAME <#{EMAIL}>$/
+
+      def replace_first_author #:nodoc:
+        year = Time.now.year
+
+        @comment = @comment.gsub(YEAR_KEY, "\\1 #{year}.")
+        unless @translator.nil?
+          @comment = @comment.gsub(FIRST_AUTHOR_KEY,
+                                   "\\1 #{@translator}, \\2")
+        end
+      end
+
+      COPYRIGHT_KEY = /(\s*#\s* Copyright \(C\)) YEAR (THE PACKAGE'S COPYRIGHT HOLDER)$/
+      def replace_copyright_year #:nodoc:
+        date = Time.now
+
+        @comment = @comment.gsub(COPYRIGHT_KEY, "\\1 #{date.year} \\2")
+      end
+    end
+  end
+end