lib/rbot/load-gettext.rb

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