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