gettext 2.3.9 → 3.0.0

data/.yardopts

@@ -1,5 +1,6 @@
 --protected
 --no-private
+--markup markdown
 --output doc/reference/en
 --title "gettext API Reference"
 -

data/README.rdoc

@@ -1,5 +1,15 @@
 = gettext - gettext for Ruby
 
+NOTE: Gettext gem 3.0.0 removed many deprecated APIs and improves
+internal APIs. We want to keep backward compatibility as much as
+possible but some existing codes may be broken by gettext gem API
+change. If your code breaks by gettext gem 3.0.0, please report your
+problem. We will fix the problem and release a new version.
+
+https://github.com/ruby-gettext/gettext is the official gettext gem
+repository. It is moved from https://github.com/mutoh/gettext . Mutoh
+agreed with the move.
+
 Gettext gem is a pure Ruby Localization(L10n) library and tool
 which is modeled after the GNU gettext package.
 
@@ -7,30 +17,29 @@ This library was called as "Ruby-GetText-Package". Since 2.3.0, this
 library is called just "gettext". You can call this library as
 "gettext gem" or "Ruby gettext" to distinguish from GNU gettext.
 
-This library translates original messages to localized  
-messages using client-side locale information(environment  
+This library translates original messages to localized
+messages using client-side locale information(environment
 variable or CGI variable).
 
-The tools for developers support creating, useing, and modifying  
+The tools for developers support creating, useing, and modifying
 localized message files(message catalogs).
 
 ((*Rails*))
-Rails support has been removed.  
-Rails / ActiveRecord specific code now lives in locale_rails[http://github.com/mutoh/locale_rails/tree/master], gettext_rails[http://github.com/mutoh/gettext_rails/tree/master] and gettext_activerecord[http://github.com/mutoh/gettext_activerecord/tree/master].
+Rails support has been removed.
 
 == Website
-* homepage[http://ruby-gettext.github.com/]
+* homepage[http://ruby-gettext.github.io/]
 * on github[http://github.com/ruby-gettext/gettext]
 
 == Features
 * Translate singular/plural messages with simple APIs(similar to GNU gettext)
 
-* Thread safety. Message resources are shared from all threads, but 
+* Thread safety. Message resources are shared from all threads, but
   returns translated messages of the current thread's locale.
 
 * Tools to find message IDs
   * Extract message IDs to po-files using rxgettext from
-    * ruby scripts 
+    * ruby scripts
     * glade-2 XML file(.glade)
     * ERB file(.rhtml, .erb)
     * Anything (with your own parsers)
@@ -49,17 +58,13 @@ Rails / ActiveRecord specific code now lives in locale_rails[http://github.com/m
   * Locale is retrieved from client informations using Ruby-Locale.
     (HTTP_ACCEPT_LANGUAGE, HTTP_ACCEPT_CHARSET, QUERY_STRING(lang), Cookies(lang)).
 
-* String%() is extended to use named argument such as <tt>%{foo}" %{:foo => 1}</tt>.
-  Notes that Ruby-1.9.x supports this format by itself.
-
 == Requirements
-* {Ruby 1.8.3 or later}[http://www.ruby-lang.org]
-* {Rubygems}[http://www.rubygems.org/]
-* {locale gem}[http://rubyforge.org/projects/locale/]
+* {Ruby 1.9.3 or later}[http://www.ruby-lang.org]
+* {RubyGems}[http://www.rubygems.org/]
+* {locale gem}[http://ruby-gettext.github.io/]
   * $ gem install locale
 * (for development only)
-  * {GNU gettext 0.10.35 or later}[http://www.gnu.org/software/gettext/gettext.html]
-  * {Racc-1.4.3 or later}[http://www.ruby-lang.org/raa/list.rhtml?name=racc]
+  * {Racc-1.4.3 or later}[http://rubygems.org/gems/racc]
     * (for compiling src/rmsgfmt.ry only)
 
 == Install
@@ -68,7 +73,7 @@ Rails / ActiveRecord specific code now lives in locale_rails[http://github.com/m
     gem uninstall gettext
 
 * gem
-    #from rubyforge 
+    #from rubyforge
     (sudo/su on POSIX system)
     gem install gettext
 
@@ -77,7 +82,7 @@ Rails / ActiveRecord specific code now lives in locale_rails[http://github.com/m
     (sudo/su on POSIX system)
     ruby setup.rb
 
-You can also install files in your favorite directory by  
+You can also install files in your favorite directory by
 supplying setup.rb some options. Try <tt>ruby setup.rb --help</tt>.
 
 == Usage
@@ -121,7 +126,7 @@ The gettext methods comes in 3 combinable flavors
 
 === Bind textdomains to the classes.
 A textdomain has a translation file in each language.
-A module/class can have multi textdomains. This means the 
+A module/class can have multi textdomains. This means the
 libraries/applications can have their own textdomains.
 
  class Foo
@@ -199,7 +204,7 @@ LGPL(Lesser General Public License: doc/text/lgpl-3.0.txt or http://www.gnu.org/
 * Korean(ko)                 - Gyoung-Yoon Noh <nohmad at gmail.com>
 * Latvian(lv)                - Aivars Akots <aivars.akots at gmail.com>
 * Norwegian(nb)              - Runar Ingebrigtsen <runar at mopo.no>
-* Portuguese(Brazil)(pt_BR)  
+* Portuguese(Brazil)(pt_BR)
   * Antonio S. de A. Terceiro <terceiro at softwarelivre.org> (current)
   * Joao Pedrosa <joaopedrosa at gmail.com>
 * Russian(ru)                - Yuri Kozlov <kozlov.y at gmail.com>
@@ -223,14 +228,14 @@ LGPL(Lesser General Public License: doc/text/lgpl-3.0.txt or http://www.gnu.org/
 * English(default)          - 2.1.0
 * Esperanto(eo)             - 2.0.1
 * Estonian(et)              - 2.0.1
-* French(fr)                - 2.0.1 
+* French(fr)                - 2.0.1
 * German(de)                - 2.0.1
-* Greek(el)                 - 2.0.1 
+* Greek(el)                 - 2.0.1
 * Hungarian(hu)             - 2.0.1
 * Italian(it)               - 1.6.0 (old)
 * Japanese(ja)              - 2.1.0
 * Korean(ko)                - 1.9.0 (old)
-* Latvian(lv)               - 2.0.1 
+* Latvian(lv)               - 2.0.1
 * Norwegian(nb)             - 2.0.1
 * Portuguese(Brazil)(pt_BR) - 2.0.1
 * Russian(ru)               - 2.0.1

data/Rakefile

@@ -8,7 +8,7 @@
 # You don't need to use this file directly.
 #
 # Copyright(c) 2005-2009 Masao Mutoh
-# Copyright(c) 2012 Kouhei Sutou <kou@clear-code.com>
+# Copyright(c) 2012-2013 Kouhei Sutou <kou@clear-code.com>
 # Copyright(c) 2012 Haruka Yoshihara <yoshihara@clear-code.com>
 # This program is licenced under the same licence as Ruby.
 
@@ -20,8 +20,7 @@ require "rake"
 require "rubygems"
 require "yard"
 require "gettext/version"
-require "gettext/tools"
-require "gettext/task"
+require "gettext/tools/task"
 require "bundler/gem_helper"
 
 class Bundler::GemHelper
@@ -40,25 +39,25 @@ task :default => :test
 ############################################################
 # GetText tasks for developing
 ############################################################
-poparser_rb_path = "lib/gettext/tools/poparser.rb"
-desc "Create #{poparser_rb_path}"
-task :poparser => poparser_rb_path
+po_parser_rb_path = "lib/gettext/po_parser.rb"
+desc "Create #{po_parser_rb_path}"
+task :po_parser => po_parser_rb_path
 
 def fix_racc_output_indent(racc_output)
   racc_output.gsub(/^  (end\s*\# module GetText)$/, '\1')
 end
 
-poparser_ry_path = "src/poparser.ry"
-file poparser_rb_path => poparser_ry_path do
+po_parser_ry_path = "src/po_parser.ry"
+file po_parser_rb_path => po_parser_ry_path do
   racc = File.join(Gem.bindir, "racc")
-  tempfile = Tempfile.new("gettext-poparser")
-  ruby(racc, "-g", poparser_ry_path, "-o", tempfile.path)
+  tempfile = Tempfile.new("gettext-po-parser")
+  ruby(racc, "-g", po_parser_ry_path, "-o", tempfile.path)
 
-  File.open(poparser_rb_path, "w") do |poparser_rb|
-    poparser_rb.puts(<<-EOH)
+  File.open(po_parser_rb_path, "w") do |po_parser_rb|
+    po_parser_rb.puts(<<-EOH)
 # -*- coding: utf-8 -*-
 #
-# poparser.rb - Generate a .mo
+# po_parser.rb - Generate a .mo
 #
 # Copyright (C) 2003-2009 Masao Mutoh <mutomasa at gmail.com>
 # Copyright (C) 2012 Kouhei Sutou <kou@clear-code.com>
@@ -68,7 +67,7 @@ file poparser_rb_path => poparser_ry_path do
 
 EOH
 
-    poparser_rb.puts(fix_racc_output_indent(tempfile.read))
+    po_parser_rb.puts(fix_racc_output_indent(tempfile.read))
   end
 end
 
@@ -80,13 +79,18 @@ end
 
 namespace :test do
   desc "Prepare test environment"
-  task :prepare => ["test:gettext", "samples:gettext"]
+  task :prepare => [:po_parser, "test:gettext", "samples:gettext"]
+end
+
+xgettext_options = ["--add-comments=TRANSLATORS:"]
+GetText::Tools::Task.new(spec) do |task|
+  task.xgettext_options.concat(xgettext_options)
 end
 
-GetText::Task.new(spec)
 Dir.glob("samples/*.rb") do |target|
   domain = File.basename(target, ".*")
-  GetText::Task.new(spec) do |task|
+  GetText::Tools::Task.new(spec) do |task|
+    task.xgettext_options.concat(xgettext_options)
     task.domain = domain
     task.namespace_prefix = "samples:#{domain}"
     task.po_base_directory = "samples/po"
@@ -104,7 +108,8 @@ task "samples:gettext"
   ["helloerb2", Dir.glob("samples/cgi/helloerb2.cgi")],
   ["hellolib", Dir.glob("samples/cgi/hellolib.rb")],
 ].each do |domain, files|
-  GetText::Task.new(spec) do |task|
+  GetText::Tools::Task.new(spec) do |task|
+    task.xgettext_options.concat(xgettext_options)
     task.domain = domain
     task.namespace_prefix = "samples:cgi:#{domain}"
     task.po_base_directory = "samples/cgi/po"
@@ -119,7 +124,8 @@ task "samples:cgi:gettext"
 task "samples:gettext" => "samples:cgi:gettext"
 
 ["untranslated", "backslash", "non_ascii", "np_", "p_"].each do |domain|
-  GetText::Task.new(spec) do |task|
+  GetText::Tools::Task.new(spec) do |task|
+    task.xgettext_options.concat(xgettext_options)
     task.domain = domain
     task.namespace_prefix = "test:#{domain}"
     task.po_base_directory = "test/po"
@@ -131,7 +137,8 @@ task "samples:gettext" => "samples:cgi:gettext"
 end
 
 ["_", "s_", "ns_"].each do |domain|
-  GetText::Task.new(spec) do |task|
+  GetText::Tools::Task.new(spec) do |task|
+    task.xgettext_options.concat(xgettext_options)
     task.domain = domain
     task.namespace_prefix = "test:#{domain}"
     task.po_base_directory = "test/po"
@@ -147,7 +154,8 @@ po_only_domains = [
   "plural", "plural_error", "rubyparser", "test1", "test2", "test3"
 ]
 po_only_domains.each do |domain|
-  GetText::Task.new(spec) do |task|
+  GetText::Tools::Task.new(spec) do |task|
+    task.xgettext_options.concat(xgettext_options)
     task.domain = domain
     task.namespace_prefix = "test:#{domain}"
     task.po_base_directory = "test/po"

data/doc/text/news.md

@@ -1,5 +1,62 @@
 # News
 
+## <a id="3-0-0">3.0.0</a>: 2013-08-31
+
+This is a new major version up release!
+
+This release removes many deprecated APIs and improves internal
+APIs. We want to keep backward compatibility as much as possible but
+some existing codes may be broken by gettext gem API change. If your
+code breaks by gettext gem 3.0.0, please report your problem. We will
+fix the problem and release a new version.
+
+### Improvements
+
+  * Removed deprecated APIs
+    * `require "gettext/parser/erb"`.
+       Use `require "gettext/tools/parser/erb"` instead.
+    * `require "gettext/parser/glade"`.
+      Use `require "gettext/tools/parser/glade"` instead.
+    * `require "gettext/parser/ruby"`.
+      Use `require "gettext/tools/parser/ruby"` instead.
+    * `require "gettext/utils"`.
+      Use `require "gettext/tools"` instead.
+    * `GetText.msgmerge`. Use `GetText::Tools::MsgMerge.run` instead.
+    * `GetText.create_mofiles`. Use `GetText::Tools::Task` instead.
+    * `GetText::PoParser`. Use `GetText::POParser` instead.
+    * `require "gettext/tools/poparser"`.
+       Use `require "gettext/po_parser"` instead.
+    * `require "gettext/runtime/mofile"`.
+       Use `require "gettext/mo"` instead.
+    * `GetText::MoFile`. Use `GetText::MO` instead.
+    * `GetText::Task`. Use `GetText::Tools::Task` instead.
+    * `GetText.set_locale_all`. Use `GetText.set_locale` instead.
+    * `GetText.setlocale`. Use `GetText.set_locale` instead.
+    * `GetText::Tools::MsgMerge::PoData`. Use `GetText::POEntry` instead.
+  * Removed Ruby 1.8 support.
+  * Supported Rake 10.1.0.
+  * Stopped to remove `TRANSLATORS:` tag because GNU gettext doesn't
+    remove it.
+  * Stopped to use `TRANSLATORS:` as comment tag. It is GNU gettext
+    compatible behavior.
+  * rxgettext: Added `--add-comments[=TAG]` option that exists in
+    xgettext. [GitHub #16] [Reported by Ladislav Slezák]
+  * Supported escaping tab character as `\t`.
+
+### Fixes
+
+  * po: Added a missing new line for multiple extracted comments.
+    [GitHub #17] [Patch by Ladislav Slezák]
+  * Fixed a bug that encoding may not be set.
+  * Fixed a bug that `\n` is escaped as `\\n`.
+    [GitHub #18] [Debian #716916] [Reported by Ladislav Slezák]
+    [Reported by Francesco Poli]
+
+### Thanks
+
+  * Ladislav Slezák
+  * Francesco Poli
+
 ## <a id="2-3-9">2.3.9</a>: 2013-04-21
 
 This is a msgmerge updated release.

data/gettext.gemspec

@@ -28,7 +28,7 @@ So you can use GNU gettext tools for maintaining.
     s.test_files = Dir.glob("test/test_*.rb")
   end
 
-  s.add_runtime_dependency("locale")
+  s.add_runtime_dependency("locale", ">= 2.0.5")
   s.add_runtime_dependency("text")
   s.add_development_dependency("rake")
   s.add_development_dependency("racc")

data/lib/gettext.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# -*- coding: utf-8 -*-
 
 =begin
   gettext.rb - GetText module
@@ -13,25 +13,13 @@
   license terms as Ruby or LGPL.
 =end
 
-if Object.constants.include? "Gem"
-  begin
-    begin
-      gem 'locale', '>=2.0.5'
-    rescue Gem::LoadError
-    end
-  rescue NoMethodError
-  else LoadError
-  end
-end
-
 require 'locale'
-raise "Install locale as gem or uninstall old gettext" unless Locale.respond_to? :candidates
 
 require 'gettext/version'
-require 'gettext/runtime/textdomain_manager'
+require 'gettext/text_domain_manager'
 
 module GetText
-  # If the textdomain isn't bound when calling GetText.textdomain, this error is raised.
+  # If the text domain isn't bound when calling GetText.textdomain, this error is raised.
   class NoboundTextDomainError < RuntimeError
     def initialize(domainname)
       @domainname = domainname
@@ -49,12 +37,12 @@ module GetText
 
   # bindtextdomain(domainname, options = {})
   #
-  # Bind a textdomain(%{path}/%{locale}/LC_MESSAGES/%{domainname}.mo) to
+  # Bind a text domain(%{path}/%{locale}/LC_MESSAGES/%{domainname}.mo) to
   # your program.
   # Normally, the texdomain scope becomes the class/module(and parent
   # classes/included modules).
   #
-  # * domainname: the textdomain name.
+  # * domainname: the text domain name.
   # * options: options as an Hash.
   #   * :path - the path to the mo-files. When the value is nil, it will search default paths such as
   #     /usr/share/locale, /usr/local/share/locale)
@@ -66,9 +54,9 @@ module GetText
     bindtextdomain_to(self, domainname, *options)
   end
 
-  # Includes GetText module and bind a textdomain to a class.
+  # Includes GetText module and bind a text domain to a class.
   # * klass: the target ruby class.
-  # * domainname: the textdomain name.
+  # * domainname: the text domain name.
   # * options: options as an Hash. See GetText.bindtextdomain.
   def bindtextdomain_to(klass, domainname, *options)
     if options[0].kind_of? Hash
@@ -85,23 +73,23 @@ module GetText
     TextDomainManager.bind_to(klass, domainname, opts)
   end
 
-  # Binds a existed textdomain to your program.
+  # Binds a existed text domain to your program.
   # This is the same function with GetText.bindtextdomain but simpler(and faster) than bindtextdomain.
   # Note that you need to call GetText.bindtextdomain first. If the domainname hasn't bound yet,
   # raises GetText::NoboundTextDomainError.
-  # * domainname: a textdomain name.
+  # * domainname: a text domain name.
   # * Returns: the GetText::TextDomainManager.
   def textdomain(domainname) #:nodoc:
     textdomain_to(self, domainname)
   end
 
-  # Includes GetText module and bind an exsited textdomain to a class.
-  # See textdomain for more detail.
+  # Includes GetText module and bind an exsited text domain to a class.
+  # See text domain for more detail.
   # * klass: the target ruby class.
-  # * domainname: the textdomain name.
+  # * domainname: the text domain name.
 
   def textdomain_to(klass, domainname)  #:nodoc:
-    domain = TextDomainManager.textdomain_pool(domainname)
+    domain = TextDomainManager.text_domain_pool(domainname)
     raise NoboundTextDomainError.new(domainname) unless domain
     bindtextdomain_to(klass, domainname)
   end
@@ -305,8 +293,4 @@ unless defined? XX
   # http://rubyforge.org/projects/codeforpeople/
   alias :p_ :pgettext #:nodoc:
 end
-
-  # for backward compatibility
-  alias :set_locale_all :set_locale #:nodoc:
-  alias :setlocale :set_locale #:nodoc:
 end

data/lib/gettext/cgi.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# -*- coding: utf-8 -*-
 
 =begin
   gettext/cgi.rb - GetText for CGI

data/lib/gettext/{runtime/class_info.rb → class_info.rb}

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# -*- coding: utf-8 -*-
 
 require 'locale/util/memoizable'
 

data/lib/gettext/{runtime/locale_path.rb → locale_path.rb}

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# -*- coding: utf-8 -*-
 
 =begin
   locale_path.rb - GetText::LocalePath
@@ -11,7 +11,6 @@
 =end
 
 require 'rbconfig'
-require 'gettext/core_ext/string'
 
 module GetText
   # Treats locale-path for mo-files.