class GetText::Tools::XGetText

Public Class Methods

add_parser(parser) click to toggle source

Adds a parser to the default parser list.

@param (see add_parser) @return [void]

@see add_parser

# File lib/gettext/tools/xgettext.rb, line 41
def add_parser(parser)
  @@default_parsers.unshift(parser)
end
run(*arguments) click to toggle source
# File lib/gettext/tools/xgettext.rb, line 31
def run(*arguments)
  new.run(*arguments)
end

Public Instance Methods

add_parser(parser) click to toggle source

The parser object requires to have target?(path) and parse(path) method.

@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 = []
    # Simple entry
    entry = POEntry.new(:normal)
    entry.msgid = "hello"
    entry.references = ["foo.rb:200", "bar.rb:300"]
    entry.add_comment("Comment for the entry")
    po << entry
    # Plural entry
    entry = POEntry.new(:plural)
    entry.msgid = "An apple"
    entry.msgid_plural = "Apples"
    entry.references = ["foo.rb:200", "bar.rb:300"]
    po << entry
    # Simple entry with the entry context
    entry = POEntry.new(:msgctxt)
    entry.msgctxt = "context"
    entry.msgid = "hello"
    entry.references = ["foo.rb:200", "bar.rb:300"]
    po << entry
    # Plural entry with the message context.
    entry = POEntry.new(:msgctxt_plural)
    entry.msgctxt = "context"
    entry.msgid = "An apple"
    entry.msgid_plural = "Apples"
    entry.references = ["foo.rb:200", "bar.rb:300"]
    po << entry
    return po
  end
end

GetText::XGetText.add_parser(FooParser.new)

@param [#target?, parse] parser

It parses target file and extracts translate target entries from the
target file. If there are multiple target files, parser.parse is
called multiple times.

@return [void]

# File lib/gettext/tools/xgettext.rb, line 128
def add_parser(parser)
  @parsers.unshift(parser)
end

Private Instance Methods

encode(string) click to toggle source
# File lib/gettext/tools/xgettext.rb, line 347
def encode(string)
  if string.respond_to?(:encode)
    string.encode(@output_encoding)
  else
    string # don't support
  end
end
now() click to toggle source
# File lib/gettext/tools/xgettext.rb, line 284
def now
  Time.now
end
parse_path(path, po) click to toggle source
# File lib/gettext/tools/xgettext.rb, line 288
def parse_path(path, po)
  @parsers.each do |parser|
    next unless parser.target?(path)

    extracted_po = parser.parse(path)
    extracted_po.each do |po_entry|
      if po_entry.kind_of?(Array)
        po_entry = POEntry.new_from_ary(po_entry)
      end

      if po_entry.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.reference 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_entry.references = po_entry.references.collect do |reference|
          path, line, = reference.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.empty?
        existing = nil
      else
        entry = po.find {|t| t.mergeable?(po_entry)}
        existing = po.index(entry)
      end

      if existing
        po_entry = po[existing].merge(po_entry)
        po[existing] = po_entry
      else
        po << po_entry
      end
    end
    break
  end
end