gettext 3.0.3 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5dd7b69714925629b741151ac292ea6cdd610594
-  data.tar.gz: d46007fce3f43d56375c311bcf13c0edbc493adb
+  metadata.gz: 1d86db1459c880200329b35e33e864f61379b19e
+  data.tar.gz: 1a5bf66f9c2635dbb6ed24381c561d8caf60f0d1
 SHA512:
-  metadata.gz: e902eb611d9e036c68aafcd6b2f0cb462c43344b683ee841a5792e2a5061dc587f351ddf172e0234eebad4a0f0d87aa7c9ef3c563a04b129ecba94dec35e0399
-  data.tar.gz: 57ab4f506008399e3b5b0c52a2ecdb09cbc2f1f401abdfd8005a238228b9fcbe4e90f182dfb5db4d57b7a8c14f5f9b532d74b1dd5c4d479873936311f5d63e78
+  metadata.gz: eec3c5b571d10f2554973fdc5250bf6349a6f9580c264609cf551c721ed5ec4be3ad43bb5fe9616c23924492b90666ea2b12630c83bc38725ded0bd1c6fa3539
+  data.tar.gz: 23c26b971dc36dbd92b9e3015650cae86293788bd9a3d9a5534fe15e4f6026723634f66b5c4ca5a04bb11eea0e2ff76599b7e0f92f2832910b9a4e37e690b475

data/bin/rmsgcat

@@ -0,0 +1,22 @@
+#! /usr/bin/env ruby
+#
+# Copyright (C) 2014  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/msgcat"
+
+GetText::Tools::MsgCat.run(*ARGV)

data/doc/text/news.md

@@ -1,5 +1,19 @@
 # News
 
+## <a id="3-0-4">3.0.4</a>: 2014-02-02
+
+### Improvements
+
+  * Supported `Module#prepend`. [GitHub#29] [Reported by akira yamada]
+  * Added {GetText::POEntry#fuzzy?}.
+  * Added {GetText::Tools::MsgCat}.
+  * Added `rmsgcat` command. [GitHub#23] [Requested by Andreas Loupasakis]
+
+### Thanks
+
+  * akira yamada
+  * Andreas Loupasakis
+
 ## <a id="3-0-3">3.0.3</a>: 2013-12-15
 
 ### Improvements

data/lib/gettext/class_info.rb

@@ -38,7 +38,8 @@ module GetText
       end
       analyzed_classes << klass unless analyzed_classes.include? klass
 
-      klass.ancestors[1..-1].each do |a|
+      klass.ancestors.each do |a|
+        next if a == klass
         ret += related_classes_internal(a, all_classes, analyzed_classes)
         ret.uniq!
       end

data/lib/gettext/po.rb

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2012-2013  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2012-2014  Kouhei Sutou <kou@clear-code.com>
 # Copyright (C) 2012  Haruka Yoshihara <yoshihara@clear-code.com>
 #
 # License: Ruby's or LGPL
@@ -38,13 +38,20 @@ module GetText
     # @!attribute [rw] order
     #   The order is used to sort PO entries(objects of {POEntry}) in
     #   {#to_s}.
-    #   @param [Symbol] order the name as order by sort.
-    #     Now :reference is allowed only.
+    #   @param [:reference, :msgid] order (:reference) The sort key.
+    #
+    #     Use `:reference` for sorting by location that message is placed.
+    #
+    #     Use `:msgid` for sorting by msgid alphabetical order.
+    #
+    #     `:references` is deprecated since 3.0.4. It will be removed
+    #     at 4.0.0. Use `:reference` instead.
+    #
     #   @return [Symbol] the name as order by sort.
     attr_accessor :order
 
     def initialize(order=nil)
-      @order = order || :references
+      @order = order || :reference
       @entries = {}
     end
 
@@ -214,8 +221,8 @@ module GetText
     private
     def sort(entries)
       case @order
-      when :references
-        sorted_entries = sort_by_references(entries)
+      when :reference, :references # :references is deprecated.
+        sorted_entries = sort_by_reference(entries)
       when :msgid
         sorted_entries = sort_by_msgid(entries)
       else
@@ -223,10 +230,10 @@ module GetText
       end
     end
 
-    def sort_by_references(entries)
+    def sort_by_reference(entries)
       entries.each do |_, entry|
         entry.references = entry.references.sort do |reference, other|
-          compare_references(reference, other)
+          compare_reference(reference, other)
         end
       end
 
@@ -234,11 +241,11 @@ module GetText
         # msgid_entry = [[msgctxt, msgid], POEntry]
         entry_first_reference = msgid_entry[1].references.first
         other_first_reference = other_msgid_entry[1].references.first
-        compare_references(entry_first_reference, other_first_reference)
+        compare_reference(entry_first_reference, other_first_reference)
       end
     end
 
-    def compare_references(reference, other)
+    def compare_reference(reference, other)
       entry_source, entry_line_number = split_reference(reference)
       other_source, other_line_number = split_reference(other)
 

data/lib/gettext/po_entry.rb

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2012-2013  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2012-2014  Kouhei Sutou <kou@clear-code.com>
 # Copyright (C) 2010  masone (Christian Felder) <ema@rh-productions.ch>
 # Copyright (C) 2009  Masao Mutoh
 #
@@ -58,7 +58,9 @@ module GetText
     attr_accessor :references    # ["file1:line1", "file2:line2", ...]
     attr_accessor :translator_comment
     attr_accessor :extracted_comment
-    attr_accessor :flag
+    # @return [Array<String>] The flags for this PO entry.
+    # @since 3.0.4
+    attr_accessor :flags
     attr_accessor :previous
     attr_accessor :comment
 
@@ -68,7 +70,7 @@ module GetText
       @translator_comment = nil
       @extracted_comment = nil
       @references = []
-      @flag = nil
+      @flags = []
       @previous = nil
       @msgctxt = nil
       @msgid = nil
@@ -87,6 +89,24 @@ module GetText
       end
     end
 
+    # @return [String, nil] The flag of the PO entry.
+    # @deprecated Since 3.0.4. Use {#flags} instead.
+    def flag
+      @flags.first
+    end
+
+    # Set the new flag for the PO entry.
+    #
+    # @param [String, nil] flag The new flag.
+    # @deprecated Since 3.0.4. Use {#flags=} instead.
+    def flag=(flag)
+      if flag.nil?
+        @flags = []
+      else
+        @flags = [flag]
+      end
+    end
+
     # Checks if the self has same attributes as other.
     def ==(other)
       not other.nil? and
@@ -99,7 +119,7 @@ module GetText
         translator_comment == other.translator_comment and
         extracted_comment == other.extracted_comment and
         references == other.references and
-        flag == other.flag and
+        flags == other.flags and
         previous == other.previous and
         comment == other.comment
     end
@@ -177,6 +197,12 @@ module GetText
       @type == :normal and @msgid == :last
     end
 
+    # @return true if the entry is fuzzy entry, false otherwise.
+    #   Fuzzy entry has "fuzzy" flag.
+    def fuzzy?
+      @flags.include?("fuzzy")
+    end
+
     def [](number)
       param = @param_type[number]
       raise ParseError, 'no more string parameters expected' unless param
@@ -218,8 +244,22 @@ module GetText
 
       # @param [POEntry] entry The entry to be formatted.
       # @param [Hash] options
+      # @option options [Bool] :include_translator_comment (true)
+      #   Includes translator comments in formatted string if true.
+      # @option options [Bool] :include_extracted_comment (true)
+      #   Includes extracted comments in formatted string if true.
       # @option options [Bool] :include_reference_comment (true)
       #   Includes reference comments in formatted string if true.
+      # @option options [Bool] :include_flag_comment (true)
+      #   Includes flag comments in formatted string if true.
+      # @option options [Bool] :include_previous_comment (true)
+      #   Includes previous comments in formatted string if true.
+      # @option options [Bool] :include_all_comments (true)
+      #   Includes all comments in formatted string if true.
+      #   Other specific `:include_XXX` options get preference over
+      #   this option.
+      #   You can remove all comments by specifying this option as
+      #   false and omitting other `:include_XXX` options.
       # @option options [Integer] :max_line_width (78)
       #   Wraps long lines that is longer than the `:max_line_width`.
       #   Don't break long lines if `:max_line_width` is less than 0
@@ -228,7 +268,7 @@ module GetText
       #   Encodes to the specific encoding.
       def initialize(entry, options={})
         @entry = entry
-        @options = fill_default_option_values(options)
+        @options = normalize_options(options)
       end
 
       def format
@@ -236,14 +276,7 @@ module GetText
           return format_obsolete_comment(@entry.comment)
         end
 
-        str = ""
-        str << format_translator_comment
-        str << format_extracted_comment
-        if @options[:include_reference_comment]
-          str << format_reference_comment
-        end
-        str << format_flag_comment
-        str << format_previous_comment
+        str = format_comments
 
         # msgctxt, msgid, msgstr
         if @entry.msgctxt?
@@ -285,15 +318,66 @@ module GetText
       end
 
       private
-      def fill_default_option_values(options)
+      def normalize_options(options)
         options = options.dup
-        if options[:include_reference_comment].nil?
-          options[:include_reference_comment] = true
+        include_comment_keys = [
+          :include_translator_comment,
+          :include_extracted_comment,
+          :include_reference_comment,
+          :include_flag_comment,
+          :include_previous_comment,
+        ]
+        if options[:include_all_comments].nil?
+          options[:include_all_comments] = true
+        end
+        default_include_comment_value = options[:include_all_comments]
+        include_comment_keys.each do |key|
+          options[key] = default_include_comment_value if options[key].nil?
         end
         options[:max_line_width] ||= DEFAULT_MAX_LINE_WIDTH
         options
       end
 
+      def include_translator_comment?
+        @options[:include_translator_comment]
+      end
+
+      def include_extracted_comment?
+        @options[:include_extracted_comment]
+      end
+
+      def include_reference_comment?
+        @options[:include_reference_comment]
+      end
+
+      def include_flag_comment?
+        @options[:include_flag_comment]
+      end
+
+      def include_previous_comment?
+        @options[:include_previous_comment]
+      end
+
+      def format_comments
+        formatted_comment = ""
+        if include_translator_comment?
+          formatted_comment << format_translator_comment
+        end
+        if include_extracted_comment?
+          formatted_comment << format_extracted_comment
+        end
+        if include_reference_comment?
+          formatted_comment << format_reference_comment
+        end
+        if include_flag_comment?
+          formatted_comment << format_flag_comment
+        end
+        if include_previous_comment?
+          formatted_comment << format_previous_comment
+        end
+        formatted_comment
+      end
+
       def format_translator_comment
         format_comment("#", @entry.translator_comment)
       end
@@ -326,7 +410,11 @@ module GetText
       end
 
       def format_flag_comment
-        format_comment(FLAG_MARK, @entry.flag)
+        formatted_flags = ""
+        @entry.flags.each do |flag|
+          formatted_flags << format_comment(FLAG_MARK, flag)
+        end
+        formatted_flags
       end
 
       def format_previous_comment
@@ -365,11 +453,16 @@ module GetText
       end
 
       def format_message(message)
-        return "\"\"\n" if message.nil?
+        empty_formatted_message = "\"\"\n"
+        return empty_formatted_message if message.nil?
 
         chunks = wrap_message(message)
+        return empty_formatted_message if chunks.empty?
+
         formatted_message = ""
-        formatted_message << "\"\"\n" if chunks.size > 1
+        if chunks.size > 1 or chunks.first.end_with?("\n")
+          formatted_message << empty_formatted_message
+        end
         chunks.each do |chunk|
           formatted_message << "\"#{escape(chunk)}\"\n"
         end

data/lib/gettext/po_parser.rb

@@ -10,7 +10,7 @@
 
 #
 # DO NOT MODIFY!!!!
-# This file is automatically generated by Racc 1.4.9
+# This file is automatically generated by Racc 1.4.11
 # from Racc grammer file "".
 #
 
@@ -64,7 +64,7 @@ module_eval(<<'...end po_parser.ry/module_eval...', 'po_parser.ry', 123)
     @translator_comments = []
     @extracted_comments = []
     @references = []
-    @flag = []
+    @flags = []
     @previous = []
     @comments = []
     @data = data
@@ -139,7 +139,7 @@ module_eval(<<'...end po_parser.ry/module_eval...', 'po_parser.ry', 123)
       entry = POEntry.new(type)
       entry.translator_comment = format_comment(@translator_comments)
       entry.extracted_comment = format_comment(@extracted_comments)
-      entry.flag = format_comment(@flag)
+      entry.flags = @flags
       entry.previous = format_comment(@previous)
       entry.references = @references
       entry.msgctxt = @msgctxt
@@ -159,7 +159,7 @@ module_eval(<<'...end po_parser.ry/module_eval...', 'po_parser.ry', 123)
     @translator_comments = []
     @extracted_comments = []
     @references = []
-    @flag = []
+    @flags = []
     @previous = []
     @references = []
     @comments.clear
@@ -191,7 +191,7 @@ module_eval(<<'...end po_parser.ry/module_eval...', 'po_parser.ry', 123)
         when POFormat::REFERENCE_COMMENT_MARK
           @references.concat(parse_references_line(content))
         when POFormat::FLAG_MARK
-          @flag << content
+          @flags.concat(parse_flags_line(content))
         when POFormat::PREVIOUS_COMMENT_MARK
           @previous << content
         else
@@ -258,6 +258,10 @@ module_eval(<<'...end po_parser.ry/module_eval...', 'po_parser.ry', 123)
   def parse_references_line(line)
     line.split(/\s+/)
   end
+
+  def parse_flags_line(line)
+    line.split(/\s+/)
+  end
 ...end po_parser.ry/module_eval...
 ##### State transition tables begin ###
 

data/lib/gettext/tools/msgcat.rb

@@ -0,0 +1,246 @@
+# Copyright (C) 2014  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 "optparse"
+require "gettext"
+require "gettext/po_parser"
+require "gettext/po"
+
+module GetText
+  module Tools
+    class MsgCat
+      class << self
+        # (see #run)
+        #
+        # This method is provided just for convenience. It equals to
+        # `new.run(*command_line)`.
+        def run(*command_line)
+          new.run(*command_line)
+        end
+      end
+
+      # Concatenates po-files.
+      #
+      # @param [Array<String>] command_line
+      #   The command line arguments for rmsgcat.
+      # @return [void]
+      def run(*command_line)
+        config = Config.new
+        config.parse(command_line)
+
+        parser = POParser.new
+        parser.report_warning = config.report_warning?
+        parser.ignore_fuzzy = !config.include_fuzzy?
+        output_po = PO.new
+        output_po.order = config.order
+        merger = Merger.new(output_po, config)
+        config.pos.each do |po_file_name|
+          po = PO.new
+          parser.parse_file(po_file_name, po)
+          merger.merge(po)
+        end
+
+        output_po_string = output_po.to_s(config.po_format_options)
+        if config.output.is_a?(String)
+          File.open(File.expand_path(config.output), "w") do |file|
+            file.print(output_po_string)
+          end
+        else
+          puts(output_po_string)
+        end
+      end
+
+      # @private
+      class Merger
+        def initialize(output_po, config)
+          @output_po = output_po
+          @config = config
+        end
+
+        def merge(po)
+          po.each do |entry|
+            id = [entry.msgctxt, entry.msgid]
+            if @output_po.has_key?(*id)
+              merged_entry = merge_entry(@output_po[*id], entry)
+            else
+              merged_entry = entry
+            end
+            @output_po[*id] = merged_entry if merged_entry
+          end
+        end
+
+        private
+        def merge_entry(base_entry, new_entry)
+          if base_entry.header?
+            return merge_header(base_entry, new_entry)
+          end
+
+          if base_entry.fuzzy?
+            return merge_fuzzy_entry(base_entry, new_entry)
+          end
+
+          base_entry
+        end
+
+        def merge_header(base_entry, new_entry)
+          base_entry
+        end
+
+        def merge_fuzzy_entry(base_entry, new_entry)
+          if new_entry.fuzzy?
+            base_entry
+          else
+            new_entry
+          end
+        end
+      end
+
+      # @private
+      class Config
+        include GetText
+
+        bindtextdomain("gettext")
+
+        # @return [Array<String>] The input PO file names.
+        attr_accessor :pos
+
+        # @return [String] The output file name.
+        attr_accessor :output
+
+        # @return [:reference, :msgid] The sort key.
+        attr_accessor :order
+
+        # @return [Hash] The PO format options.
+        # @see PO#to_s
+        # @see POEntry#to_s
+        attr_accessor :po_format_options
+
+        # (see include_fuzzy?)
+        attr_writer :include_fuzzy
+
+        # (see report_warning?)
+        attr_writer :report_warning
+
+        def initialize
+          @pos = []
+          @output = nil
+          @order = nil
+          @po_format_options = {
+            :max_line_width => POEntry::Formatter::DEFAULT_MAX_LINE_WIDTH,
+          }
+          @include_fuzzy = true
+          @report_warning = true
+        end
+
+        # @return [Boolean] Whether includes fuzzy entries or not.
+        def include_fuzzy?
+          @include_fuzzy
+        end
+
+        # @return [Boolean] Whether reports warning messages or not.
+        def report_warning?
+          @report_warning
+        end
+
+        def parse(command_line)
+          parser = create_option_parser
+          @pos = parser.parse(command_line)
+        end
+
+        private
+        def create_option_parser
+          parser = OptionParser.new
+          parser.version = GetText::VERSION
+          parser.banner = _("Usage: %s [OPTIONS] PO_FILE1 PO_FILE2 ...") % $0
+          parser.separator("")
+          parser.separator(_("Concatenates and merges PO files."))
+          parser.separator("")
+          parser.separator(_("Specific options:"))
+
+          parser.on("-o", "--output=FILE",
+                    _("Write output to specified file"),
+                    _("(default: the standard output)")) do |output|
+            @output = output
+          end
+
+          parser.on("--sort-by-msgid",
+                    _("Sort output by msgid")) do
+            @order = :msgid
+          end
+
+          parser.on("--sort-by-location",
+                    _("Sort output by location")) do
+            @order = :reference
+          end
+
+          parser.on("--sort-by-file",
+                    _("Sort output by location"),
+                    _("It is same as --sort-by-location"),
+                    _("Just for GNU gettext's msgcat compatibility")) do
+            @order = :reference
+          end
+
+          parser.on("--[no-]sort-output",
+                    _("Sort output by msgid"),
+                    _("It is same as --sort-by-msgid"),
+                    _("Just for GNU gettext's msgcat compatibility")) do |sort|
+            @order = sort ? :msgid : nil
+          end
+
+          parser.on("--no-location",
+                    _("Remove location information")) do |boolean|
+            @po_format_options[:include_reference_comment] = boolean
+          end
+
+          parser.on("--no-all-comments",
+                    _("Remove all comments")) do |boolean|
+            @po_format_options[:include_all_comments] = boolean
+          end
+
+          parser.on("--width=WIDTH", Integer,
+                    _("Set output page width"),
+                    "(#{@po_format_options[:max_line_width]})") do |width|
+            @po_format_options[:max_line_width] = width
+          end
+
+          parser.on("--[no-]wrap",
+                    _("Break long message lines, longer than the output page width, into several lines"),
+                    "(#{@po_format_options[:max_line_width] >= 0})") do |wrap|
+            if wrap
+              max_line_width = POEntry::Formatter::DEFAULT_MAX_LINE_WIDTH
+            else
+              max_line_width = -1
+            end
+            @po_format_options[:max_line_width] = max_line_width
+          end
+
+          parser.on("--no-fuzzy",
+                    _("Ignore fuzzy entries")) do |include_fuzzy|
+            @include_fuzzy = include_fuzzy
+          end
+
+          parser.on("--no-report-warning",
+                    _("Don't report warning messages")) do |report_warning|
+            @report_warning = report_warning
+          end
+
+          parser
+        end
+      end
+    end
+  end
+end