marvin 0.8.0.0

data/test/parser_comparison.rb

@@ -0,0 +1,62 @@
+require 'benchmark'
+require File.join(File.dirname(__FILE__),'../lib/marvin')
+
+LINES = [
+  ":irc.darth.vpn.spork.in 366 testbot #testing :End of NAMES list",
+  ":Helsinki.FI.EU.Undernet.org PONG Helsinki.FI.EU.Undernet.org :Helsinki.FI.EU.Undernet.org",
+  ":testnick USER guest tolmoon tolsun :Ronnie Reagan",
+  "LIST #twilight_zone,#42",
+  ":WiZ LINKS *.bu.edu *.edu",
+  ":Angel PRIVMSG Wiz :Hello are you receiving this message ?",
+  ":RelayBot!n=MarvinBo@203.161.81.201.static.amnet.net.au JOIN :#relayrelay",
+  ":SuttoL!n=SuttoL@li6-47.members.linode.com PRIVMSG #relayrelay :testing...",
+  ":wolfe.freenode.net 004 MarvinBot3000 wolfe.freenode.net hyperion-1.0.2b aAbBcCdDeEfFGhHiIjkKlLmMnNopPQrRsStTuUvVwWxXyYzZ01234569*@ bcdefFhiIklmnoPqstv"
+]
+PARSERS = [Marvin::Parsers::SimpleParser, Marvin::Parsers::RagelParser]
+
+LINES.each do |line|
+  
+  puts "Processing: #{line}"
+  puts ""
+  cmd = []
+  
+  PARSERS.each do |p|
+    parser = p.new(line)
+    ev    = parser.to_event
+    puts "Parser:  #{p.name}"
+    if ev.nil?
+      puts "Unknown Event"
+    else
+      puts ev.to_hash.inspect
+    end
+    puts ""
+  end
+  puts ""
+  
+end
+
+puts ""
+puts ""
+puts "==============="
+puts "| SPEED TESTS |"
+puts "==============="
+puts ""
+
+width = PARSERS.map { |p| p.name.length }.max + 2
+
+ITERATIONS = 100
+
+Benchmark.bm(width) do |b|
+  PARSERS.each do |parser|
+    b.report("#{parser.name}: ") do
+      LINES.each do |l|
+        ITERATIONS.times do
+          e = parser.new(l).to_event
+          unless e.nil?
+            e.to_hash # Get a hash
+          end
+        end
+      end
+    end
+  end
+end

data/test/parser_test.rb

@@ -0,0 +1,266 @@
+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
+  
+  # The default parser
+  @@parser = Marvin::Settings.parser
+  
+  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.nick
+    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.nick
+    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,62 @@
+require 'rubygems'
+
+# Testing dependencies
+require 'test/unit'
+require 'shoulda'
+# RedGreen doesn't seem to be needed under 1.9
+require 'redgreen' if RUBY_VERSION < "1.9"
+
+require 'pathname'
+root_directory = Pathname.new(__FILE__).dirname.join("..").expand_path
+require root_directory.join("lib", "marvin")
+
+Marvin::Settings.setup!
+Marvin::Logger.setup!
+
+Marvin::Settings.client = Marvin::TestClient
+
+class Test::Unit::TestCase
+
+  @test_client = nil
+
+  protected
+
+  def client(force_new = false)
+    @test_client = Marvin::TestClient.new if force_new || @test_client.nil?
+    @test_client
+  end
+  
+  # Short hand for creating a class with
+  # a given class_eval block.
+  def class_via(*args, &blk)
+    klass = Class.new(*args)
+    klass.class_eval(&blk) unless blk.blank?
+    return klass
+  end
+  
+  # Short hand for creating a test class
+  # for a set of mixins - give it the modules
+  # and it will include them all.
+  def test_class_for(*mods, &blk)
+    klass = Class.new
+    klass.class_eval { include(*mods) }
+    klass.class_eval(&blk) unless blk.blank?
+    return klass
+  end
+  
+  def assert_dispatched(name, position = -1, opts = nil)
+    res = client.dispatched_events[position]
+    assert !res.nil?
+    assert_equal name, res[0]
+    assert_equal opts, res[1] if !opts.nil?
+  end
+  
+  def assert_sent_line(line, position = -1)
+    assert_equal line, client.outgoing_commands[position]
+  end
+  
+  def assert_resets_client
+    assert_equal [], client(true).dispatched_events
+  end
+  
+end

data/test/util_test.rb

@@ -0,0 +1,57 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class UtilTest < Test::Unit::TestCase
+  
+  context "Converting a string to a channel name" do
+    
+    should "not convert it if it starts with #" do
+      assert_equal "#offrails", Marvin::Util.channel_name("#offrails")
+    end
+    
+    should "append a # if not present" do
+      assert_equal "#offrails", Marvin::Util.channel_name("offrails")
+    end
+    
+    should "also be available as chan" do
+      assert_equal "#offrails", Marvin::Util.chan("#offrails")
+      assert_equal "#offrails", Marvin::Util.chan("offrails")
+    end
+    
+  end
+  
+  context "Parsing arguments" do
+    
+    should "parse 'a b c' as ['a', 'b', 'c']" do
+      assert_equal ['a', 'b', 'c'], Marvin::Util.arguments("a b c")
+    end
+    
+    should "parse 'a b :c d' as ['a', 'b', 'c d']" do
+      assert_equal ['a', 'b', 'c d'], Marvin::Util.arguments("a b :c d")
+    end
+    
+    should "parse 'a :b c :d e' as ['a', 'b c :d e']" do
+      assert_equal ['a', 'b c :d e'], Marvin::Util.arguments('a :b c :d e')
+    end
+    
+  end
+  
+  context "Preparing last parameters" do
+    
+    should "prepend a :" do
+      assert_equal ':zomg ninjas',  Marvin::Util.last_param('zomg ninjas')
+      assert_equal '::zomg ninjas', Marvin::Util.last_param(':zomg ninjas')
+    end
+    
+    should "strip the input" do
+      assert_equal ':zomg ninjas', Marvin::Util.last_param('   zomg ninjas ')
+    end
+    
+    should "be available as lp" do
+      assert_equal ':zomg ninjas',  Marvin::Util.lp('zomg ninjas')
+      assert_equal '::zomg ninjas', Marvin::Util.lp(':zomg ninjas')
+      assert_equal ':zomg ninjas',  Marvin::Util.lp('   zomg ninjas ')
+    end
+    
+  end
+  
+end