lib/rbot/load-gettext.rb

   1 #-- vim:sw=2:et
   2 #++
   3 #
   4 # :title: GetText interface for rbot
   5 #
   6 # Load gettext module and provide fallback in case of failure
   7
   8 class GetTextVersionError < Exception
   9 end
  10
  11 # try to load gettext, or provide fake getttext functions
  12 begin
  13   require 'gettext/version'
  14
  15   gettext_version = GetText::VERSION.split('.').map {|n| n.to_i}
  16   include Comparable # for Array#>=
  17   unless gettext_version >= [1, 8, 0]
  18     raise GetTextVersionError, "Unsupported ruby-gettext version installed: #{gettext_version.join '.'}; supported versions are 1.8.0 and above"
  19   end
  20
  21   require 'gettext'
  22
  23   include GetText
  24
  25   add_default_locale_path(File.join(Irc::Bot::Config.datadir, "../locale/%{locale}/LC_MESSAGES/%{name}.mo"))
  26
  27   bindtextdomain 'rbot'
  28
  29   module GetText
  30     # patch for ruby-gettext 1.8.0 up to 1.10.0 (and more?) to cope with anonymous
  31     # modules used by rbot
  32     # FIXME remove the patch when ruby-gettext is fixed, or rbot switches to named modules
  33     if !instance_methods.include?('orig_bound_targets')
  34       alias :orig_bound_targets :bound_targets
  35     end
  36     def bound_targets(*a)  # :nodoc:
  37       bt = orig_bound_targets(*a) rescue []
  38       bt.empty? ? orig_bound_targets(Object) : bt
  39     end
  40
  41     require 'stringio'
  42
  43     # This method is used to output debug information on the GetText
  44     # textdomain, and it's called by the language setting routines
  45     # in rbot
  46     def rbot_gettext_debug
  47       begin
  48         gettext_info = StringIO.new
  49         current_textdomain_info(:out => gettext_info) # fails sometimes
  50       rescue Exception
  51         warning "gettext failed to set call textdomain info. maybe an mo file doesn't exist for your locale."
  52       ensure
  53         gettext_info.string.each_line { |l| debug l}
  54       end
  55     end
  56   end
  57
  58   log "gettext loaded"
  59
  60 rescue LoadError, GetTextVersionError
  61   warn "failed to load ruby-gettext package: #{$!}; translations are disabled"
  62
  63   # undefine GetText, in case it got defined because the error was caused by a
  64   # wrong version
  65   if defined?(GetText)
  66     Object.module_eval { remove_const("GetText") }
  67   end
  68
  69   # dummy functions that return msg_id without translation
  70   def _(s)
  71     s
  72   end
  73
  74   def N_(s)
  75     s
  76   end
  77
  78   def n_(s_single, s_plural, n)
  79     n > 1 ? s_plural : s_single
  80   end
  81
  82   def Nn_(s_single, s_plural)
  83     n_(s_single, s_plural)
  84   end
  85
  86   def s_(*args)
  87     args[0]
  88   end
  89
  90   # the following extension to String#% is from ruby-gettext's string.rb file.
  91   # it needs to be included in the fallback since the source already use this form
  92
  93 =begin
  94   string.rb - Extension for String.
  95
  96   Copyright (C) 2005,2006 Masao Mutoh
  97
  98   You may redistribute it and/or modify it under the same
  99   license terms as Ruby.
 100 =end
 101
 102   # Extension for String class.
 103   #
 104   # String#% method which accept "named argument". The translator can know
 105   # the meaning of the msgids using "named argument" instead of %s/%d style.
 106   class String
 107     alias :_old_format_m :% # :nodoc:
 108
 109     # call-seq:
 110     #  %(arg)
 111     #  %(hash)
 112     #
 113     # Format - Uses str as a format specification, and returns the result of applying it to arg.
 114     # If the format specification contains more than one substitution, then arg must be
 115     # an Array containing the values to be substituted. See Kernel::sprintf for details of the
 116     # format string. This is the default behavior of the String class.
 117     # * arg: an Array or other class except Hash.
 118     # * Returns: formatted String
 119     #
 120     #  (e.g.) "%s, %s" % ["Masao", "Mutoh"]
 121     #
 122     # Also you can use a Hash as the "named argument". This is recommanded way for Ruby-GetText
 123     # because the translators can understand the meanings of the msgids easily.
 124     # * hash: {:key1 => value1, :key2 => value2, ... }
 125     # * Returns: formatted String
 126     #
 127     #  (e.g.) "%{firstname}, %{familyname}" % {:firstname => "Masao", :familyname => "Mutoh"}
 128     def %(args)
 129       if args.kind_of?(Hash)
 130         ret = dup
 131         args.each {|key, value|
 132           ret.gsub!(/\%\{#{key}\}/, value.to_s)
 133         }
 134         ret
 135       else
 136         ret = gsub(/%\{/, '%%{')
 137         begin
 138     ret._old_format_m(args)
 139         rescue ArgumentError
 140     $stderr.puts "  The string:#{ret}"
 141     $stderr.puts "  args:#{args.inspect}"
 142         end
 143       end
 144     end
 145   end
 146 end