rubot 0.1.5 → 0.2

data/bin/rubot

@@ -6,7 +6,7 @@ require "template"
 
 options = OpenStruct.new
 parser = OptionParser.new do |parser|
-  parser.banner = "Usage: #{__FILE__} <options>"
+  parser.banner = "Usage: #{File.basename(__FILE__)} <options>"
   
   parser.separator ""
   parser.separator "Initialization"
@@ -19,17 +19,22 @@ parser = OptionParser.new do |parser|
   parser.separator ""
   parser.separator "Generators"
   
-  parser.on("-c", "--command Name", "Generates a new command named Name") do |name|
+  parser.on("-c", "--command Name", "Generates a new command") do |name|
     generate_command(name)
     exit
   end
   
-  parser.on("-l", "--listener Name", "Generates a new listener named Name") do |name|
+  parser.on("-e", "--exiter Name", "Generates a new exiter") do |name|
+    generate_exiter(name)
+    exit
+  end
+  
+  parser.on("-l", "--listener Name", "Generates a new listener") do |name|
     generate_listener(name)
     exit
   end
   
-  parser.on("-r", "--runner Name", "Generates a new listener named Name") do |name|
+  parser.on("-r", "--runner Name", "Generates a new listener") do |name|
    generate_runner(name)
     exit
   end

data/lib/core.rb

@@ -3,6 +3,7 @@ module Rubot
     require "core/command"
     require "core/listener"
     require "core/runner"
+    require "core/exiter"
     require "core/dispatcher"
   end
 end

data/lib/core/dispatcher.rb

@@ -42,6 +42,7 @@ module Rubot
         reload
         # runners are only run on server connection, so there's no need them to be in reload 
         load_dir "runners", @runners = {}
+        load_dir "exiters", @exiters = {}
       end
 
       # Called when successful connection is made to a server. This is when the runners are
@@ -116,6 +117,15 @@ module Rubot
       def remove_auth(nick)
         @auth_list.delete nick
       end
+      
+      # Handles the on quit event, which is triggered when the server recieves the
+      # quit message or an interrupt is triggered.
+      #
+      # ==== Parameters
+      # server<Rubot::Irc::Server>:: The server that is quiting.
+      def on_quit(server)
+        execute_exiters(server)
+      end
 
       private
 
@@ -126,6 +136,14 @@ module Rubot
       def run_runners(server)
         @runners.each_value {|runner| runner.run(server)}
       end
+      
+      # Executes all exiters with the given server.
+      #
+      # ==== Parameters
+      # server<Rubot::Irc::Server>:: Server instance
+      def execute_exiters(server)
+        @exiters.each_value {|exiter| exiter.execute(server)}
+      end
 
       # Loads all files in the given directory and stores the class instances
       # in the given set. This is used to load commands, listeners, and runners.

data/lib/core/exiter.rb

@@ -0,0 +1,36 @@
+module Rubot
+  module Core
+    # Base class for all exiters. An exiter cannot be called directly, but is executed
+    # when the server receives the quit message or an interrupt is triggered
+    #
+    # ==== Example
+    # This exiter says goodbye to all channels the bot is in.
+    #   class Bye < Rubot::Core::Exiter
+    #     def execute(server)
+    #       server.channels.each do |channel|
+    #         server.msg(channel, "bye everybody!")
+    #       end
+    #     end
+    #   end
+    class Exiter
+      # Takes an instance of Rubot::Core::Dispatcher. Any
+      # child class that needs a constructor should override
+      # this method.
+      #
+      # ==== Parameters
+      # dispatcher<Rubot::Core::Dispatcher>:: The dispatcher that was used to create
+      # the instance of the exiter.
+      def initialize(dispatcher)
+        @dispatcher = dispatcher
+      end
+  
+      # Runs the exiter with the given server.
+      #
+      # ==== Paramters
+      # server<Rubot::Irc::Server>:: Server instance the exiter should use for
+      # messaging and information.
+      def execute(server)
+      end
+    end
+  end
+end

data/lib/generators/exiters.template

@@ -0,0 +1,7 @@
+class --NAME-- < Rubot::Core::Exiter
+  def execute(server)
+    server.channels.each do |channel|
+      server.msg(channel, "goodbye cruel world")
+    end
+  end
+end

data/lib/irc/message_queue.rb

@@ -101,6 +101,7 @@ module Rubot
               @lock.synchronize do
                 @thread = Thread.new { flush } unless @thread && @thread.alive?
               end
+              @thread
             end
           end
           nil

data/lib/irc/server.rb

@@ -38,31 +38,37 @@ module Rubot
         @message_queue.action do |destination, action|
           raw "PRIVMSG #{destination} :\001ACTION #{action}\001"
         end
+        
+        @message_queue.quit do |blah, more_blah|
+          raw "QUIT :#{@quit_message}"
+          @conn.close
+        end
       end
   
       # Attempts to make a connection to the server
       def connect
         return if @is_connected
-    
+
         @conn = TCPSocket.open(@host, @port, @vhost)
         raw "USER #{@nick} #{@nick} #{@nick} :#{@real_name}"
         change_nick @nick
         join @channels
-    
+
         begin
-            main_loop()
+          main_loop()
         rescue Interrupt
+          quit
         rescue Exception => detail
-            puts detail.message()
-            print detail.backtrace.join("\n")
-            retry
+          puts detail.message()
+          print detail.backtrace.join("\n")
+          retry
         end
       end
   
       # Sends the quit command to the IRC server, then closes the connection.
       def quit
-        raw "QUIT :#{@quit_message}"
-        @conn.close
+        @dispatcher.on_quit(self)
+        @message_queue.quit("Hades", "ice water plz").join
       end
   
       # Changes our nick.

data/lib/template.rb

@@ -32,7 +32,12 @@ def generate_runner(name)
   generate("runners", name)
 end
 
+def generate_exiter(name)
+  generate("exiters", name)
+end
+
 def generate(template, name)
+  FileUtils.mkdir(template) unless Dir.exist?(template)
   filename = File.join(template, "#{name.underscore}.rb")
   puts "file '#{filename}' already exists" and return if File.exist?(filename)
   

metadata

@@ -4,9 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 5
-  version: 0.1.5
+  - 2
+  version: "0.2"
 platform: ruby
 authors: 
 - Chris Thorn
@@ -14,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-10 00:00:00 -08:00
+date: 2010-04-13 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -30,6 +29,7 @@ files:
 - bin/rubot
 - lib/core/command.rb
 - lib/core/dispatcher.rb
+- lib/core/exiter.rb
 - lib/core/listener.rb
 - lib/core/runner.rb
 - lib/core.rb
@@ -37,6 +37,7 @@ files:
 - lib/extensions/string.rb
 - lib/extensions.rb
 - lib/generators/commands.template
+- lib/generators/exiters.template
 - lib/generators/listeners.template
 - lib/generators/runners.template
 - lib/irc/constants.rb