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