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       orig_bound_targets(*a) rescue orig_bound_targets(Object)
  38     end
  39
  40     require 'stringio'
  41
  42     # This method is used to output debug information on the GetText
  43     # textdomain, and it's called by the language setting routines
  44     # in rbot
  45     def rbot_gettext_debug
  46       begin
  47         gettext_info = StringIO.new
  48         current_textdomain_info(:out => gettext_info) # fails sometimes
  49       rescue Exception
  50         warning "gettext failed to set call textdomain info. maybe an mo file doesn't exist for your locale."
  51       ensure
  52         gettext_info.string.each_line { |l| debug l}
  53       end
  54     end
  55   end
  56
  57   log "gettext loaded"
  58
  59 rescue LoadError, GetTextVersionError
  60   warn "failed to load ruby-gettext package: #{$!}; translations are disabled"
  61
  62   # undefine GetText, in case it got defined because the error was caused by a
  63   # wrong version
  64   if defined?(GetText)
  65     Object.module_eval { remove_const("GetText") }
  66   end
  67
  68   # dummy functions that return msg_id without translation
  69   def _(s)
  70     s
  71   end
  72
  73   def N_(s)
  74     s
  75   end
  76
  77   def n_(s_single, s_plural, n)
  78     n > 1 ? s_plural : s_single
  79   end
  80
  81   def Nn_(s_single, s_plural)
  82     n_(s_single, s_plural)
  83   end
  84
  85   def s_(*args)
  86     args[0]
  87   end
  88
  89   # the following extension to String#% is from ruby-gettext's string.rb file.
  90   # it needs to be included in the fallback since the source already use this form
  91
  92 =begin
  93   string.rb - Extension for String.
  94
  95   Copyright (C) 2005,2006 Masao Mutoh
  96
  97   You may redistribute it and/or modify it under the same
  98   license terms as Ruby.
  99 =end
 100
 101   # Extension for String class.
 102   #
 103   # String#% method which accept "named argument". The translator can know
 104   # the meaning of the msgids using "named argument" instead of %s/%d style.
 105   class String
 106     alias :_old_format_m :% # :nodoc:
 107
 108     # call-seq:
 109     #  %(arg)
 110     #  %(hash)
 111     #
 112     # Format - Uses str as a format specification, and returns the result of applying it to arg.
 113     # If the format specification contains more than one substitution, then arg must be
 114     # an Array containing the values to be substituted. See Kernel::sprintf for details of the
 115     # format string. This is the default behavior of the String class.
 116     # * arg: an Array or other class except Hash.
 117     # * Returns: formatted String
 118     #
 119     #  (e.g.) "%s, %s" % ["Masao", "Mutoh"]
 120     #
 121     # Also you can use a Hash as the "named argument". This is recommanded way for Ruby-GetText
 122     # because the translators can understand the meanings of the msgids easily.
 123     # * hash: {:key1 => value1, :key2 => value2, ... }
 124     # * Returns: formatted String
 125     #
 126     #  (e.g.) "%{firstname}, %{familyname}" % {:firstname => "Masao", :familyname => "Mutoh"}
 127     def %(args)
 128       if args.kind_of?(Hash)
 129         ret = dup
 130         args.each {|key, value|
 131           ret.gsub!(/\%\{#{key}\}/, value.to_s)
 132         }
 133         ret
 134       else
 135         ret = gsub(/%\{/, '%%{')
 136         begin
 137     ret._old_format_m(args)
 138         rescue ArgumentError
 139     $stderr.puts "  The string:#{ret}"
 140     $stderr.puts "  args:#{args.inspect}"
 141         end
 142       end
 143     end
 144   end
 145 end