imdb plugin: bring help up to speed with what the plugin offers

[user/henk/code/ruby/rbot.git] / data / rbot / plugins / bans.rb

diff --git a/data/rbot/plugins/bans.rb b/data/rbot/plugins/bans.rb
index 39f50b0065b1da926ae87325067a0bc7bebfd31e..73121b7ef505abd4883d014f21f7b8f5235d78ba 100644 (file)
--- a/data/rbot/plugins/bans.rb
+++ b/data/rbot/plugins/bans.rb
@@ -1,10 +1,19 @@
-# BansPlugin v3 for 0.9.11\r
+#-- vim:sw=2:et\r
+#++\r
 #\r
-# Managing kick and bans, automatically removing bans after timeouts, quiet bans, and kickban/quietban based on regexp\r
+# :title: Bans Plugin v3 for rbot 0.9.11 and later\r
 #\r
-# (c) 2006 Marco Gulino <marco@kmobiletools.org>\r
-# (c) 2007 kamu <mr.kamu@gmail.com>\r
-# (c) 2007 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>\r
+# Author:: Marco Gulino <marco@kmobiletools.org>\r
+# Author:: kamu <mr.kamu@gmail.com>\r
+# Author:: Giuseppe Bilotta <giuseppe.bilotta@gmail.com>\r
+#\r
+# Copyright:: (C) 2006 Marco Gulino\r
+# Copyright:: (C) 2007 kamu, Giuseppe Bilotta\r
+#\r
+# License:: GPL V2.\r
+#\r
+# Managing kick and bans, automatically removing bans after timeouts, quiet\r
+# bans, and kickban/quietban based on regexp\r
 #\r
 # v1 -> v2 (kamu's version, never released)\r
 #   * reworked\r
@@ -13,20 +22,19 @@
 #\r
 # v2 -> v3 (GB)\r
 #   * remove the 'bans' prefix from most of the commands\r
-#   * (un)quiet has been renamed to (un)silence because 'quiet' was used to tell the bot to keep quiet\r
+#   * (un)quiet has been renamed to (un)silence because 'quiet' was used to\r
+#     tell the bot to keep quiet\r
 #   * both (un)quiet and (un)silence are accepted as actions\r
 #   * use the more descriptive 'onjoin' term for autoactions\r
-#   * convert v1's (0.9.10) :bans and :bansmasks to BadWordActions and WhitelistEntries\r
+#   * convert v1's (0.9.10) :bans and :bansmasks to BadWordActions and\r
+#     WhitelistEntries\r
 #   * enhanced list manipulation facilities\r
 #   * fixed regexp usage in requirements for plugin map\r
 #   * add proper auth management\r
-#\r
-# Licensed under GPL V2.\r
-\r
-OnJoinAction = Struct.new("OnJoinAction", :host, :action, :channel, :reason)\r
-BadWordAction = Struct.new("BadWordAction", :regexp, :action, :channel, :timer, :reason)\r
-WhitelistEntry = Struct.new("WhitelistEntry", :host, :channel)\r
 \r
+define_structure :OnJoinAction, :host, :action, :channel, :reason\r
+define_structure :BadWordAction, :regexp, :action, :channel, :timer, :reason\r
+define_structure :WhitelistEntry, :host, :channel\r
 \r
 class BansPlugin < Plugin\r
 \r
@@ -41,7 +49,7 @@ class BansPlugin < Plugin
   end\r
 \r
   def make_badword_rx(txt)\r
-    return /\b#{txt}\b/i\r
+    return /\b(?:#{txt})\b/i\r
   end\r
 \r
   def initialize\r