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