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