jeffrafter-marvin 0.1.20081115 → 0.1.20081120

data/test/parser_test.rb

@@ -0,0 +1,264 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+# In reality this tests several different classes:
+# 1) The parser itself
+# 2) The Command class
+# 3) The two different types of prefixes
+# 4) The Event class
+class ParserTest < Test::Unit::TestCase
+  @@parser = Marvin::Parsers::SimpleParser
+  
+  context "When parsing a LIST" do
+    setup { @parsed = @@parser.new("LIST #twilight_zone,#42") }
+    
+    should "not be nil" do
+      assert !@parsed.nil?
+    end
+    
+    should "have a command" do
+      assert !@parsed.command.nil?
+    end
+    
+    should "have not a prefix" do
+      assert @parsed.command.prefix.nil?
+    end
+    
+    should "have a code of LIST" do
+      assert_equal "LIST", @parsed.command.code
+    end
+    
+    should "have the correct arguments" do
+      assert_equal ["#twilight_zone,#42"], @parsed.command.params
+    end
+    
+    should "be able to convert to an event" do
+      assert !@parsed.to_event.nil?
+    end
+    
+    should "have the correct incoming event name" do
+      assert_equal :incoming_list, @parsed.to_event.to_incoming_event_name
+    end
+    
+    should "have the correct outgoing event name" do
+      assert_equal :outgoing_list, @parsed.to_event.to_outgoing_event_name
+    end
+    
+    should "convert to the correct hash" do
+      assert_equal({:channel => "#twilight_zone,#42", :target => ""}, @parsed.to_event.to_hash)
+    end
+    
+  end
+  
+  context "When parsing a JOIN" do
+    setup { @parsed = @@parser.new(":RelayBot!n=MarvinBot@static.amnet.net.au JOIN :#relayrelay") }
+    
+    should "not be nil" do
+      assert !@parsed.nil?
+    end
+    
+    should "have a command" do
+      assert !@parsed.command.nil?
+    end
+    
+    should "have a prefix" do
+      assert !@parsed.command.prefix.nil?
+    end
+    
+    should "have a code of JOIN" do
+      assert_equal "JOIN", @parsed.command.code
+    end
+    
+    should "have the correct arguments" do
+      assert_equal ["#relayrelay"], @parsed.command.params
+    end
+    
+    should "have a host mask" do
+      assert @parsed.command.prefix.is_a?(Marvin::Parsers::Prefixes::HostMask)
+    end
+    
+    should "have the correct nick" do
+      assert_equal "RelayBot", @parsed.command.prefix.nickname
+    end
+    
+    should "have the correct user" do
+      assert_equal "n=MarvinBot", @parsed.command.prefix.user
+    end
+    
+    should "have the correct host" do
+      assert_equal "static.amnet.net.au", @parsed.command.prefix.host
+    end
+    
+    should "be able to convert to an event" do
+      assert !@parsed.to_event.nil?
+    end
+    
+    should "have the correct incoming event name" do
+      assert_equal :incoming_join, @parsed.to_event.to_incoming_event_name
+    end
+    
+    should "have the correct outgoing event name" do
+      assert_equal :outgoing_join, @parsed.to_event.to_outgoing_event_name
+    end
+    
+    should "convert to the correct hash" do
+      assert_equal({:target => "#relayrelay", :key => ""}.merge(@parsed.command.prefix.to_hash), @parsed.to_event.to_hash)
+    end
+    
+  end
+  
+  context "When parsing a PRIVMSG" do
+    setup { @parsed = @@parser.new(":SuttoL!n=SuttoL@sutto.net PRIVMSG #relayrelay :testing...") }
+    
+    should "not be nil" do
+      assert !@parsed.nil?
+    end
+    
+    should "have a command" do
+      assert !@parsed.command.nil?
+    end
+    
+    should "have a prefix" do
+      assert !@parsed.command.prefix.nil?
+    end
+    
+    should "have a code of PRIVMSG" do
+      assert_equal "PRIVMSG", @parsed.command.code
+    end
+    
+    should "have the correct arguments" do
+      assert_equal ["#relayrelay", "testing..."], @parsed.command.params
+    end
+    
+    should "have a host mask" do
+      assert @parsed.command.prefix.is_a?(Marvin::Parsers::Prefixes::HostMask)
+    end
+    
+    should "have the correct nick" do
+      assert_equal "SuttoL", @parsed.command.prefix.nickname
+    end
+    
+    should "have the correct user" do
+      assert_equal "n=SuttoL", @parsed.command.prefix.user
+    end
+    
+    should "have the correct host" do
+      assert_equal "sutto.net", @parsed.command.prefix.host
+    end
+    
+    should "be able to convert to an event" do
+      assert !@parsed.to_event.nil?
+    end
+    
+    should "have the correct incoming event name" do
+      assert_equal :incoming_message, @parsed.to_event.to_incoming_event_name
+    end
+    
+    should "have the correct outgoing event name" do
+      assert_equal :outgoing_message, @parsed.to_event.to_outgoing_event_name
+    end
+    
+    should "convert to the correct hash" do
+      assert_equal({:target => "#relayrelay", :message => "testing..."}.merge(@parsed.command.prefix.to_hash), @parsed.to_event.to_hash)
+    end
+    
+  end
+  
+  context "When parsing a numeric - 366" do
+    setup { @parsed = @@parser.new(":irc.darth.vpn.spork.in 366 testbot #testing :End of NAMES list") }
+    
+    should "not be nil" do
+      assert !@parsed.nil?
+    end
+    
+    should "have a command" do
+      assert !@parsed.command.nil?
+    end
+    
+    should "have a prefix" do
+      assert !@parsed.command.prefix.nil?
+    end
+    
+    should "have a code of 366" do
+      assert_equal "366", @parsed.command.code
+    end
+    
+    should "have the correct arguments" do
+      assert_equal ["testbot", "#testing", "End of NAMES list"], @parsed.command.params
+    end
+    
+    should "have a host mask" do
+      assert @parsed.command.prefix.is_a?(Marvin::Parsers::Prefixes::Server)
+    end
+    
+    should "have the correct name" do
+      assert_equal "irc.darth.vpn.spork.in", @parsed.command.prefix.name
+    end
+    
+    should "be able to convert to an event" do
+      assert !@parsed.to_event.nil?
+    end
+    
+    should "have the correct incoming event name" do
+      assert_equal :incoming_numeric, @parsed.to_event.to_incoming_event_name
+    end
+    
+    should "have the correct outgoing event name" do
+      assert_equal :outgoing_numeric, @parsed.to_event.to_outgoing_event_name
+    end
+    
+    should "convert to the correct hash" do
+      assert_equal({:code => "366", :data => "testbot #testing :End of NAMES list"}.merge(@parsed.command.prefix.to_hash), @parsed.to_event.to_hash)
+    end
+    
+  end
+  
+  context "When parsing a numeric - 004" do
+    setup { @parsed = @@parser.new(":wolfe.freenode.net 004 MarvinBot3000 wolfe.freenode.net hyperion-1.0.2b aAbBcCdDeEfFGhHiIjkKlLmMnNopPQrRsStTuUvVwWxXyYzZ01234569*@ bcdefFhiIklmnoPqstv") }
+    
+    should "not be nil" do
+      assert !@parsed.nil?
+    end
+    
+    should "have a command" do
+      assert !@parsed.command.nil?
+    end
+    
+    should "have a prefix" do
+      assert !@parsed.command.prefix.nil?
+    end
+    
+    should "have a code of 366" do
+      assert_equal "004", @parsed.command.code
+    end
+    
+    should "have the correct arguments" do
+      assert_equal ["MarvinBot3000" , "wolfe.freenode.net", "hyperion-1.0.2b", "aAbBcCdDeEfFGhHiIjkKlLmMnNopPQrRsStTuUvVwWxXyYzZ01234569*@", "bcdefFhiIklmnoPqstv"], @parsed.command.params
+    end
+    
+    should "have a host mask" do
+      assert @parsed.command.prefix.is_a?(Marvin::Parsers::Prefixes::Server)
+    end
+    
+    should "have the correct name" do
+      assert_equal "wolfe.freenode.net", @parsed.command.prefix.name
+    end
+    
+    should "be able to convert to an event" do
+      assert !@parsed.to_event.nil?
+    end
+    
+    should "have the correct incoming event name" do
+      assert_equal :incoming_numeric, @parsed.to_event.to_incoming_event_name
+    end
+    
+    should "have the correct outgoing event name" do
+      assert_equal :outgoing_numeric, @parsed.to_event.to_outgoing_event_name
+    end
+    
+    should "convert to the correct hash" do
+      assert_equal({:code => "004", :data => "MarvinBot3000 wolfe.freenode.net hyperion-1.0.2b aAbBcCdDeEfFGhHiIjkKlLmMnNopPQrRsStTuUvVwWxXyYzZ01234569*@ bcdefFhiIklmnoPqstv"}.merge(@parsed.command.prefix.to_hash), @parsed.to_event.to_hash)
+    end
+    
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+BASE_DIR = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+
+require 'rubygems'
+require 'shoulda'
+require 'test/unit'
+require File.join(BASE_DIR, "lib/marvin")
+
+class Test::Unit::TestCase
+  # Any extra helpers go here
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jeffrafter-marvin
 version: !ruby/object:Gem::Version 
-  version: 0.1.20081115
+  version: 0.1.20081120
 platform: ruby
 authors: 
 - Darcy Laycock
@@ -9,8 +9,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-15 00:00:00 -08:00
-default_executable: 
+date: 2008-11-22 00:00:00 -08:00
+default_executable: marvin
 dependencies: []
 
 description: Marvin is a Ruby IRC library / framework for ultimate awesomeness and with an evented design.
@@ -42,33 +42,43 @@ files:
 - lib/marvin/irc/base_server.rb
 - lib/marvin/irc/client.rb
 - lib/marvin/irc/event.rb
-- lib/marvin/irc/socket_client.rb
+- lib/marvin/irc/replies.rb
 - lib/marvin/irc.rb
 - lib/marvin/loader.rb
 - lib/marvin/logger.rb
 - lib/marvin/middle_man.rb
+- lib/marvin/options.rb
 - lib/marvin/parsers
+- lib/marvin/parsers/command.rb
+- lib/marvin/parsers/prefixes
+- lib/marvin/parsers/prefixes/host_mask.rb
+- lib/marvin/parsers/prefixes/server.rb
+- lib/marvin/parsers/prefixes.rb
+- lib/marvin/parsers/ragel_parser.rb
+- lib/marvin/parsers/ragel_parser.rl
 - lib/marvin/parsers/regexp_parser.rb
-- lib/marvin/parsers/simple_parser
-- lib/marvin/parsers/simple_parser/default_events.rb
-- lib/marvin/parsers/simple_parser/event_extensions.rb
-- lib/marvin/parsers/simple_parser/prefixes.rb
 - lib/marvin/parsers/simple_parser.rb
 - lib/marvin/parsers.rb
 - lib/marvin/settings.rb
 - lib/marvin/test_client.rb
 - lib/marvin/util.rb
 - lib/marvin.rb
+- test/parser_comparison.rb
+- test/parser_test.rb
+- test/test_helper.rb
 - spec/marvin
 - spec/marvin/abstract_client_test.rb
 - spec/spec_helper.rb
+- script/client
 - script/daemon-runner
-- script/run
+- script/install
+- handlers/debug_handler.rb
 - handlers/hello_world.rb
 - handlers/logging_handler.rb
 - handlers/tweet_tweet.rb
 - config/setup.rb
 - config/settings.yml.sample
+- config/connections.yml.sample
 has_rdoc: false
 homepage: http://blog.ninjahideout.com/
 post_install_message: 

data/lib/marvin/drb_handler.rb

@@ -1,7 +0,0 @@
-module Marvin
-    
-    def handle(message, options)
-    end
-    
-  end
-end

data/lib/marvin/irc/abstract_server.rb

@@ -1,4 +0,0 @@
-module Marvin::IRC
-  class AbstractServer
-  end
-end

data/lib/marvin/irc/base_server.rb

@@ -1,11 +0,0 @@
-require 'webrick'
-
-module Marvin::IRC
-  class BaseServer < WEBrick::GenericServer
-    
-    def run(sock)
-      File.open("x", "w+") { |f| f.puts sock.inspect }
-    end
-    
-  end
-end

data/lib/marvin/irc/socket_client.rb

@@ -1,69 +0,0 @@
-require 'socket'
-
-module Marvin::IRC
-  class SocketClient < Marvin::AbstractClient
-    attr_accessor :socket
-    
-    def run
-      @socket = TCPSocket.new(self.configuration.server, self.configuration.port)
-      self.process_connect
-      self.enter_loop
-    end
-    
-    def send_line(*args)
-      args.each { |l| @socket.write l } if !@socket.closed?
-    end
-    
-    def disconnect_processed?
-      @disconnect_processed
-    end
-    
-    def enter_loop
-      until @socket.closed?
-        line = @socket.readline.strip
-        receive_line line
-      end
-      self.process_disconnect unless self.disconnect_processed?
-      @disconnect_processed = true
-    rescue SystemExit
-      self.process_disconnect unless self.disconnect_processed?
-      @disconnect_processed = true
-    rescue Exception => e
-      Marvin::ExceptionTracker.log(e)
-    end
-    
-    def quit(*args)
-      super(*args)
-    end
-    
-    ## Client specific details
-    
-    def self.run
-      self.setup # So we have options etc
-      logger.debug "Connecting to #{self.configuration.server}:#{self.configuration.port}"
-      self.new.run
-    end
-    
-    def self.stop
-      logger.debug "Telling all connections to quit"
-      self.connections.each do |connection|
-        connection.quit
-        logger.debug "Preparing to close socket"
-        connection.socket.close
-      end
-      logger.debug "Stopped."
-    end
-    
-    # Registers a callback handle that will be periodically run.
-    def periodically(timing, event_callback)
-      callback = proc { self.dispatch event_callback.to_sym }
-      Thread.new do
-        while true
-          callback.call
-          sleep timing
-        end
-      end
-    end
-    
-  end
-end

data/lib/marvin/parsers/simple_parser/default_events.rb

@@ -1,37 +0,0 @@
-class Marvin::Parsers::SimpleParser < Marvin::AbstractParser
-  module DefaultEvents
-    
-    def self.included(parent)
-      parent.class_eval do
-        extend ClassMethods
-        # Register the default set of events with commands
-        register_event :nick,    :NICK,    :new_nick
-        register_event :quit,    :QUIT,    :message
-        register_event :ping,    :PING,    :data
-        register_event :join,    :JOIN,    :target
-        register_event :invite,  :INVITE,  :target,  :channel
-        register_event :message, :PRIVMSG, :target,  :message
-        register_event :part,    :PART,    :target,  :message
-        register_event :mode,    :MODE,    :target,  :mode               
-        register_event :kick,    :KICK,    :target,  :channel, :reason
-        register_event :topic,   :TOPIC,   :target,  :topic
-        # Add the default numeric event
-        register_event :numeric, :numeric, :code, :data
-        # And a few others reserved for special purposed
-        register_event :action,  :action,  :message
-        register_event :ctcp,    :ctcp,    :message
-      end
-    end
-    
-    module ClassMethods
-      
-      # Register an event from a given name,
-      # command as well as a set of arguments.
-      def register_event(name, command, *args)
-        event = Marvin::Parsers::SimpleParser::EventWithPrefix.new(name, *args)
-        self.events[command] = event
-      end
-      
-    end
-  end
-end