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