gettext 2.3.0 → 2.3.1

data/lib/gettext/tools/parser/ruby.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 =begin
   parser/ruby.rb - parser for ruby script
 
@@ -118,13 +119,30 @@ module GetText
     # (and ignored here).
     # And You don't need to keep the pomessages as unique.
 
-    def parse(path, deprecated = [])  # :nodoc:
-      lines = IO.readlines(path)
-      parse_lines(path, lines, deprecated)
+    def parse(path)  # :nodoc:
+      source = IO.read(path)
+
+      if source.respond_to?(:encode)
+        encoding = detect_encoding(source) || source.encoding
+
+        source.force_encoding(encoding)
+      end
+
+      parse_lines(path, source.each_line.to_a)
+    end
+
+    def detect_encoding(source)
+      return nil unless source.respond_to?(:force_encoding)
+      binary_source = source.dup.force_encoding("ASCII-8BIT")
+      if /\A.*coding\s*[=:]\s*([[:alnum:]\-_]+)/ =~ binary_source
+        $1.gsub(/-(?:unix|mac|dos)\z/, "")
+      else
+        nil
+      end
     end
 
-    def parse_lines(path, lines, deprecated = [])  # :nodoc:
-      pomessages = deprecated
+    def parse_lines(path, lines)  # :nodoc:
+      pomessages = []
       file = StringIO.new(lines.join + "\n")
       rl = RubyLexX.new
       rl.set_input(file)

data/lib/gettext/tools/poparser.rb

@@ -123,6 +123,7 @@ module_eval(<<'...end poparser.ry/module_eval...', 'poparser.ry', 119)
   end
 
   def on_message(msgid, msgstr)
+    msgstr = nil if msgstr.empty?
     @data[msgid] = msgstr
     @data.set_comment(msgid, @comments.join("\n"))
 
@@ -387,6 +388,6 @@ def _reduce_none(val, _values, result)
 end
 
   end   # class PoParser
-  end   # module GetText
+end   # module GetText
 
 

data/lib/gettext/tools/xgettext.rb

@@ -22,38 +22,52 @@
 
 require "pathname"
 require "optparse"
+require "locale"
 require "gettext"
 
 module GetText
   module Tools
-    class XGetText #:nodoc:
+    class XGetText
       class << self
         def run(*arguments)
           new.run(*arguments)
         end
+
+        # Adds a parser to the default parser list.
+        #
+        # @param (see #add_parser)
+        # @return [void]
+        #
+        # @see #add_parser
+        def add_parser(parser)
+          @@default_parsers.unshift(parser)
+        end
       end
 
       include GetText
 
       bindtextdomain("rgettext")
 
-      def initialize #:nodoc:
-        @ex_parsers = []
-        parsers = [
-          ["glade.rb", "GladeParser"],
-          ["erb.rb", "ErbParser"],
-          # ["ripper.rb", "RipperParser"],
-          ["ruby.rb", "RubyParser"] # Default parser.
-        ]
-        parsers.each do |f, klass|
-          begin
-            require "gettext/tools/parser/#{f}"
-            @ex_parsers << GetText.const_get(klass)
-          rescue
-            $stderr.puts(_("'%{klass}' is ignored.") % {:klass => klass})
-            $stderr.puts($!) if $DEBUG
-          end
+      # @api private
+      @@default_parsers = []
+      builtin_parser_info_list = [
+        ["glade", "GladeParser"],
+        ["erb", "ErbParser"],
+        # ["ripper", "RipperParser"],
+        ["ruby", "RubyParser"] # Default parser.
+      ]
+      builtin_parser_info_list.each do |f, klass|
+        begin
+          require "gettext/tools/parser/#{f}"
+          @@default_parsers << GetText.const_get(klass)
+        rescue
+          $stderr.puts(_("'%{klass}' is ignored.") % {:klass => klass})
+          $stderr.puts($!) if $DEBUG
         end
+      end
+
+      def initialize #:nodoc:
+        @parsers = @@default_parsers
 
         @input_files = nil
         @output = nil
@@ -62,53 +76,58 @@ module GetText
         @package_version = nil
         @msgid_bugs_address = nil
         @copyright_holder = nil
+        @output_encoding = nil
       end
 
-      # How to add your option parser
-      # The option parser module requires to have target?(file) and
-      # parser(file, ary) method.
+      # The parser object requires to have target?(path) and
+      # parse(path) method.
       #
-      #  require "gettext/tools/xgettext"
-      #  module FooParser
-      #    module_function
-      #    def target?(file)
-      #      File.extname(file) == ".foo"  # *.foo file only.
-      #    end
-      #    def parse(file)
-      #      :
-      #      ary = []
-      #      # Simple message
-      #      po = PoMessage.new(:normal)
-      #      po.msgid = "hello"
-      #      po.sources = ["foo.rb:200", "bar.rb:300"]
-      #      po.add_comment("Comment for the message")
-      #      ary << po
-      #      # Plural message
-      #      po = PoMessage.new(:plural)
-      #      po.msgid = "An apple"
-      #      po.msgid_plural = "Apples"
-      #      po.sources = ["foo.rb:200", "bar.rb:300"]
-      #      ary << po
-      #      # Simple message with the message context
-      #      po = PoMessage.new(:msgctxt)
-      #      po.msgctxt = "context"
-      #      po.msgid = "hello"
-      #      po.sources = ["foo.rb:200", "bar.rb:300"]
-      #      ary << po
-      #      # Plural message with the message context.
-      #      po = PoMessage.new(:msgctxt_plural)
-      #      po.msgctxt = "context"
-      #      po.msgid = "An apple"
-      #      po.msgid_plural = "Apples"
-      #      po.sources = ["foo.rb:200", "bar.rb:300"]
-      #      ary << po
-      #      return ary
-      #    end
-      #  end
+      # @example How to add your parser
+      #   require "gettext/tools/xgettext"
+      #   class FooParser
+      #     def target?(path)
+      #       File.extname(path) == ".foo"  # *.foo file only.
+      #     end
+      #     def parse(path)
+      #       po_messages = []
+      #       # Simple message
+      #       message = PoMessage.new(:normal)
+      #       message.msgid = "hello"
+      #       message.sources = ["foo.rb:200", "bar.rb:300"]
+      #       message.add_comment("Comment for the message")
+      #       po_messages << message
+      #       # Plural message
+      #       message = PoMessage.new(:plural)
+      #       message.msgid = "An apple"
+      #       message.msgid_plural = "Apples"
+      #       message.sources = ["foo.rb:200", "bar.rb:300"]
+      #       po_messages << message
+      #       # Simple message with the message context
+      #       message = PoMessage.new(:msgctxt)
+      #       message.msgctxt = "context"
+      #       message.msgid = "hello"
+      #       message.sources = ["foo.rb:200", "bar.rb:300"]
+      #       po_messages << message
+      #       # Plural message with the message context.
+      #       message = PoMessage.new(:msgctxt_plural)
+      #       message.msgctxt = "context"
+      #       message.msgid = "An apple"
+      #       message.msgid_plural = "Apples"
+      #       message.sources = ["foo.rb:200", "bar.rb:300"]
+      #       po_messages << message
+      #       return po_messages
+      #     end
+      #   end
       #
-      #  GetText::XGetText.add_parser(FooParser)
-      def add_parser(klass)
-        @ex_parsers.insert(0, klass)
+      #   GetText::XGetText.add_parser(FooParser.new)
+      #
+      # @param [#target?, #parse] parser
+      #   It parses target file and extracts translate target messages from the
+      #   target file. If there are multiple target files, parser.parse is
+      #   called multiple times.
+      # @return [void]
+      def add_parser(parser)
+        @parsers.unshift(parser)
       end
 
       def generate_pot_header # :nodoc:
@@ -131,99 +150,35 @@ msgstr ""
 "Language-Team: LANGUAGE <LL@li.org>\\n"
 "Language: \\n"
 "MIME-Version: 1.0\\n"
-"Content-Type: text/plain; charset=UTF-8\\n"
+"Content-Type: text/plain; charset=#{@output_encoding}\\n"
 "Content-Transfer-Encoding: 8bit\\n"
 "Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\\n"
 EOH
       end
 
       def generate_pot(paths) # :nodoc:
-        pomessages = parse(paths)
+        po_messages = parse(paths)
         str = ""
-        pomessages.each do |target|
-          str << target.to_po_str
+        po_messages.each do |target|
+          str << encode(target.to_po_str)
         end
         str
       end
 
       def parse(paths) # :nodoc:
-        pomessages = []
+        po_messages = []
         paths = [paths] if paths.kind_of?(String)
         paths.each do |path|
           begin
-            @ex_parsers.each do |klass|
-              next unless klass.target?(path)
-
-              if klass.method(:parse).arity == 1
-                targets = klass.parse(path)
-              else
-                # For backward compatibility
-                targets = klass.parse(path, [])
-              end
-
-              targets.each do |pomessage|
-                if pomessage.kind_of?(Array)
-                  pomessage = PoMessage.new_from_ary(pomessage)
-                end
-
-                if pomessage.msgid.empty?
-                  warn _("Warning: The empty \"\" msgid is reserved by " +
-                           "gettext. So gettext(\"\") doesn't returns " +
-                           "empty string but the header entry in po file.")
-                  # TODO: add pommesage.source to the pot header as below:
-                  # # SOME DESCRIPTIVE TITLE.
-                  # # Copyright (C) YEAR THE COPYRIGHT HOLDER
-                  # # This file is distributed under the same license as the PACKAGE package.
-                  # # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
-                  # #
-                  # #: test/test_gettext.rb:65
-                  # #, fuzzy
-                  # "#: test/test_gettext.rb:65" line is added.
-                  next
-                end
-
-                if @output.is_a?(String)
-                  base_path = Pathname.new(@output).dirname.expand_path
-                  pomessage.sources = pomessage.sources.collect do |source|
-                    path, line, = source.split(/:(\d+)\z/, 2)
-                    absolute_path = Pathname.new(path).expand_path
-                    begin
-                      path = absolute_path.relative_path_from(base_path).to_s
-                    rescue ArgumentError
-                      raise # Should we ignore it?
-                    end
-                    "#{path}:#{line}"
-                  end
-                end
-
-                # Save the previous target
-                if pomessages.empty?
-                  existing = nil
-                else
-                  message = pomessages.find {|t| t == pomessage}
-                  existing = pomessages.index(message)
-                end
-
-                if existing
-                  pomessage = pomessages[existing].merge(pomessage)
-                  pomessages[existing] = pomessage
-                else
-                  pomessages << pomessage
-                end
-              end
-              break
-            end
+            parse_path(path, po_messages)
           rescue
             puts(_("Error parsing %{path}") % {:path => path})
             raise
           end
         end
-        pomessages
+        po_messages
       end
 
-      # constant values
-      VERSION = GetText::VERSION
-
       def check_command_line_options(*options) # :nodoc:
         input_files, output = parse_arguments(*options)
 
@@ -279,6 +234,11 @@ EOH
           @copyright_holder = out
         end
 
+        parser.on("--output-encoding=ENCODING",
+                  _("set encoding for output")) do |encoding|
+          @output_encoding = encoding
+        end
+
         parser.on("-r", "--require=library",
                   _("require the library before executing xgettext")) do |out|
           require out
@@ -294,7 +254,7 @@ EOH
         end
 
         parser.on_tail("--version", _("display version information and exit")) do
-          puts(VERSION)
+          puts(GetText::VERSION)
           exit(true)
         end
 
@@ -306,14 +266,19 @@ EOH
       def run(*options)  # :nodoc:
         check_command_line_options(*options)
 
+        @output_encoding ||= "UTF-8"
+
+        pot_header = generate_pot_header
+        pot_messages = generate_pot(@input_files)
+
         if @output.is_a?(String)
           File.open(File.expand_path(@output), "w+") do |file|
-            file.puts(generate_pot_header)
-            file.puts(generate_pot(@input_files))
+            file.puts(pot_header)
+            file.puts(pot_messages)
           end
         else
-          @output.puts(generate_pot_header)
-          @output.puts(generate_pot(@input_files))
+          @output.puts(pot_header)
+          @output.puts(pot_messages)
         end
         self
       end
@@ -322,6 +287,92 @@ EOH
       def now
         Time.now
       end
+
+      def parse_path(path, po_messages)
+        @parsers.each do |parser|
+          next unless parser.target?(path)
+
+          extracted_po_messages = parser.parse(path)
+          extracted_po_messages.each do |po_message|
+            if po_message.kind_of?(Array)
+              po_message = PoMessage.new_from_ary(po_message)
+            end
+
+            if po_message.msgid.empty?
+              warn _("Warning: The empty \"\" msgid is reserved by " +
+                       "gettext. So gettext(\"\") doesn't returns " +
+                       "empty string but the header entry in po file.")
+              # TODO: add pommesage.source to the pot header as below:
+              # # SOME DESCRIPTIVE TITLE.
+              # # Copyright (C) YEAR THE COPYRIGHT HOLDER
+              # # This file is distributed under the same license as the PACKAGE package.
+              # # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+              # #
+              # #: test/test_gettext.rb:65
+              # #, fuzzy
+              # "#: test/test_gettext.rb:65" line is added.
+              next
+            end
+
+            if @output.is_a?(String)
+              base_path = Pathname.new(@output).dirname.expand_path
+              po_message.sources = po_message.sources.collect do |source|
+                path, line, = source.split(/:(\d+)\z/, 2)
+                absolute_path = Pathname.new(path).expand_path
+                begin
+                  path = absolute_path.relative_path_from(base_path).to_s
+                rescue ArgumentError
+                  raise # Should we ignore it?
+                end
+                "#{path}:#{line}"
+              end
+            end
+
+            # Save the previous target
+            if po_messages.empty?
+              existing = nil
+            else
+              message = po_messages.find {|t| t == po_message}
+              existing = po_messages.index(message)
+            end
+
+            if existing
+              po_message = po_messages[existing].merge(po_message)
+              po_messages[existing] = po_message
+            else
+              po_messages << po_message
+            end
+          end
+          break
+        end
+      end
+
+      def encode(string)
+        if string.respond_to?(:encode)
+          string.encode(@output_encoding)
+        else
+          string # don't support
+        end
+      end
+    end
+  end
+end
+
+# This is the module for backward compatibility,
+# but GetText::Tools::XGetText.run should be used.
+module GetText
+  module RGetText
+    def run(paths=nil, out=STDOUT)
+      warn("Warning: This method is obsolete. " +
+             "Please use GetText::Tools::XGetText.run.")
+      if paths.nil?
+        GetText::Tools::XGetText.run(*ARGV)
+      elsif out == STDOUT
+        GetText::Tools::XGetText.run(paths)
+      else
+        GetText::Tools::XGetText.run("-o", out, paths)
+      end
     end
+    module_function :run
   end
 end