summaryrefslogtreecommitdiff
path: root/data/rbot/plugins/ri.rb
blob: 9cb7edb24a41caa525d1928cd5d24b5b349db629 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
#-- vim:sw=2:et
#++
#
# :title: 'ri' -- ruby documentation plugin
#
# Author:: Eric Hodel <drbrain@segment7.net> (aka drbrain)
# Author:: Michael Brailsford  <brailsmt@yahoo.com> aka brailsmt
# Author:: dmitry kim <dmitry dot kim at gmail dot com>
# Copyright:: (C) 2007, dmitry kim
# Copyright:: (C) Eric Hodel
# Copyright:: (C) Michael Brailsford
# License:: MIT
#

class RiPlugin < Plugin

  RI_COMMAND = %w{ri -f ansi -T}

  Config.register Config::IntegerValue.new('ri.max_length',
    :default => 512,
    :desc => "Maximum length of ri entry (in bytes) which is ok to be sent to channels or other users")

  def help(plugin, topic="")
    "ri <something> => returns ruby documentation for <something>; ri [tell] <whom> [about] <something> => sends the documentation entry about <something> to <whom> using /msg"
  end

  def ri(m, params)
    tgt = nil
    if params[:who]
      if m.private?
        if params[:who] != m.sourcenick
          m.reply '"ri tell <who>" syntax is only allowed in public channels'
          return
        end
      elsif !(tgt = m.channel.users[params[:who]])
        m.reply "sorry, i don't see user #{params[:who]} here on #{m.channel}"
        return
      end
    end
    args = RI_COMMAND.dup
    if a = params[:something]
      if a == '-c'
        args.push(a)
      else
        args.push('--')
        args.push(a)
      end
    end
    begin
      ret = Utils.safe_exec(*args)
    rescue
      return m.reply("failed to execute ri")
    end
    ret = ret.gsub(/\t/, "  ").split(/\n/).join(" ").gsub(/\s\s+/, '  ')

    if ret.length > @bot.config['ri.max_length']
      if !m.private? && tgt.to_s != m.sourcenick
        return m.reply('entry is too long to send to the channel or to some other user, use /msg to ask me about it')
      end
    end
    if tgt
      @bot.say(tgt, ret)
      m.okay
    else
      m.reply(ret)
    end
    return
  end
end

plugin = RiPlugin.new
plugin.map 'ri :something', :requirements => {:something => /^((-c)|(\w\S+))$/}
plugin.map 'ri [tell] :who [about] :something',
  :requirements => {:something => /^((-c)|(\w\S+))$/}