marvin 0.8.0.0

data/lib/marvin/parsers/ragel_parser.rl

@@ -0,0 +1,143 @@
+# Ragel Parser comes from the Arrbot Guys - Kudos to Halogrium and Epitron.
+
+%%{
+  machine irc;
+  
+  action prefix_servername_start {
+    server = Prefixes::Server.new
+  }
+  
+  action prefix_servername {
+    server.name << fc
+  }
+  
+  action prefix_servername_finish {
+    command.prefix = server
+  }
+  
+  action prefix_hostmask_start {
+    hostmask =  Prefixes::HostMask.new
+  }
+  
+  action hostmask_nickname {
+    hostmask.nick << fc
+  }
+  
+  action hostmask_user {
+    hostmask.user << fc
+  }
+  
+  action hostmask_host {
+    hostmask.host << fc
+  }
+  
+  action prefix_hostmask_finish {
+    command.prefix = hostmask
+  }
+  
+  action message_code_start {
+    code = ""
+  }
+  
+  action message_code {
+    code << fc
+  }
+  
+  action message_code_finish {
+    command.code = code
+  }
+  
+  action params_start {
+    params_1 = []
+    params_2 = []
+  }
+  
+  action params {
+  }
+  
+  action params_1_start {
+    params_1 << ""
+  }
+  
+  action params_2_start {
+    params_2 << ""
+  }
+  
+  action params_1 {
+    params_1.last << fc
+  }
+
+  action params_2 {
+    params_2.last << fc
+  }
+  
+  action params_1_finish {
+    command.params = params_1
+  }
+  
+  action params_2_finish {
+    command.params = params_2
+  }
+  
+  SPACE          = " ";
+  special        = "[" | "\\" | "]" | "^" | "_" | "`" | "{" | "|" | "}" | "+";
+  nospcrlfcl     = extend - ( 0 | SPACE | '\r' | '\n' | ':' );
+  crlf           = "\r\n";
+  shortname      = ( alnum ( alnum | "-" )* alnum* ) | "*";
+  multihostname  = shortname ( ( "." | "/" ) shortname )*;
+  singlehostname = shortname ( "." | "/" );
+  hostname       = multihostname | singlehostname;
+  servername     = hostname;
+  nickname       = ( alpha | special ) ( alnum | special | "-" ){,15};
+  user           = (extend - ( 0 | "\n" | "\r" | SPACE | "@" ))+;
+  ip4addr        = digit{1,3} "." digit{1,3} "." digit{1,3} "." digit{1,3};
+  ip6addr        = ( xdigit+ ( ":" xdigit+ ){7} ) | ( "0:0:0:0:0:" ( "0" | "FFFF"i ) ":" ip4addr );
+  hostaddr       = ip4addr | ip6addr;
+  host           = hostname | hostaddr;
+  hostmask       = nickname $ hostmask_nickname ( ( "!" user $ hostmask_user )? "@" host $ hostmask_host )?;
+  prefix         = ( servername $ prefix_servername > prefix_servername_start % prefix_servername_finish ) | ( hostmask > prefix_hostmask_start % prefix_hostmask_finish );
+  code           = alpha+ | digit{3};
+  middle         = nospcrlfcl ( ":" | nospcrlfcl )*;
+  trailing       = ( ":" | " " | nospcrlfcl )*;
+  params_1       = ( SPACE middle $ params_1 > params_1_start ){,14} ( SPACE ":"  trailing $ params_1 > params_1_start )?;
+  params_2       = ( SPACE middle $ params_2 > params_2_start ){14}  ( SPACE ":"? trailing $ params_2 > params_2_start )?;
+  params         =  ( params_1 % params_1_finish | params_2 % params_2_finish ) $ params > params_start;
+  message        = ( ":" prefix SPACE )? ( code $ message_code > message_code_start % message_code_finish ) params? crlf;
+  
+  main := message;
+  
+}%%
+
+module Marvin
+  module Parsers
+    class RagelParser < Marvin::AbstractParser
+      
+      %% write data;
+      
+      private
+      
+      def self.parse!(line)
+        data = "#{line.strip}\r\n"
+
+        p = 0;
+        pe = data.length
+        cs = 0
+
+        hostmask = nil
+        server   = nil
+        code     = nil
+        command  = Command.new(data)
+
+        %% write init;
+        %% write exec;
+
+        if cs >= irc_first_final
+          command
+        else
+          raise UnparseableMessage, "Failed to parse the message: #{line.strip}"
+        end
+      end
+      
+    end
+  end
+end

data/lib/marvin/parsers/simple_parser.rb

@@ -0,0 +1,35 @@
+module Marvin
+  module Parsers
+    class SimpleParser < Marvin::AbstractParser
+      
+      private
+      
+      # Parses an incoming message by using string
+      # Manipulation.
+      def self.parse!(line)
+        prefix_text = nil
+        prefix_text, line = line.split(" ", 2) if line[0] == ?:
+        command = Command.new("#{line}\r\n")
+        command.prefix = self.extract_prefix(prefix_text)
+        parts = Marvin::Util.arguments(line)
+        command.code = parts.shift
+        command.params = parts
+        return command
+      end
+      
+      # From a given string, attempts to get the correct
+      # type of prefix (be it a HostMask or a Server name).
+      def self.extract_prefix(prefix_text)
+        return if prefix_text.blank?
+        prefix_text = prefix_text[1..-1] # Remove the leading :
+        # I think I just vomitted in my mouth a little...
+        if prefix_text =~ /^([A-Za-z0-9\-\[\]\\\`\^\|\{\}\_]+)(\!\~?([^@]+))?(@(.*))?$/
+          prefix = Prefixes::HostMask.new($1, $3, $5)
+        else
+          prefix = Prefixes::Server.new(prefix_text.strip)
+        end
+        return prefix
+      end
+    end 
+  end
+end

data/lib/marvin/settings.rb

@@ -0,0 +1,31 @@
+# Example of extending built in Perennial
+# functionality. Since const_get etc acts
+# oddly, this is the best way to do it.
+Marvin::Settings.class_eval do
+  
+  def self.parser
+    # We use SimpleParser by default because it is almost
+    # 20 times faster (from basic benchmarks) than the Ragel
+    # based parser. If you're having issues with unexpected
+    # results, please try using Ragel as the parser for you
+    # application - It was (afaik) almost a direct port
+    # from the RFC where as I've taken some liberties with
+    # simple parser for the expected reasons.
+    @@parser ||= Marvin::Parsers::SimpleParser
+  end
+  
+  def self.parser=(value)
+    raise ArgumentError, 'Is not a valid parser implementation' unless value < Marvin::AbstractParser
+    @@parser = value
+  end
+  
+  def self.client
+    @@client ||= Marvin::IRC::Client
+  end
+  
+  def self.client=(value)
+    raise ArgumentError, 'Is not a valid client implementation' unless value < Marvin::AbstractClient
+    @@client = value
+  end
+  
+end

data/lib/marvin/test_client.rb

@@ -0,0 +1,58 @@
+module Marvin
+  # Marvin::TestClient is a simple client used for testing
+  # Marvin::Base derivatives in a non-network-reliant setting.
+  class TestClient < AbstractClient
+    
+    attr_accessor :incoming_commands, :outgoing_commands, :last_sent,
+                  :dispatched_events, :connection_open
+    
+    cattr_accessor :instances
+    @@instances = []
+    
+    DispatchedEvents = Struct.new(:name, :options)
+    
+    def initialize(opts = {})
+      super
+      @incoming_commands = []
+      @outgoing_commands = []
+      @dispatched_events = []
+      @connection_open   = false
+      @@instances << self
+    end
+    
+    def connection_open?
+      !!@connection_open
+    end
+    
+    def send_line(*args)
+      @outgoing_commands += args
+      @last_sent = args.last
+    end
+    
+    def test_command(name, *args)
+      options   = args.extract_options!
+      host_mask = options.delete(:host_mask) || ":WiZ!jto@tolsun.oulu.fi"
+      name      = name.to_s.upcase
+      args      = args.flatten.compact
+      receive_line "#{host_mask} #{name} #{args.join(" ").strip}"
+    end
+    
+    def dispatch(name, opts = {})
+      @dispatched_events << [name, opts]
+      super(name, opts)
+    end
+    
+    def self.run
+      @@instances.each { |i| i.connection_open = true }
+    end
+    
+    def self.stop
+      @@instances.each { |i| i.connection_open = false }
+    end
+    
+    def self.add_reconnect(opts = {})
+      logger.info "Added reconnect with options: #{opts.inspect}"
+    end
+    
+  end
+end

data/lib/marvin/util.rb

@@ -0,0 +1,54 @@
+module Marvin
+  module Util
+      
+      GLOB_PATTERN_MAP = {
+        '*' => '.*',
+        '?' => '.',
+        '[' => '[',
+        ']' => ']'
+      }
+      
+      # Return the channel-name version of a string by
+      # appending "#" to the front if it doesn't already
+      # start with it.
+      def channel_name(name)
+        name = name.to_s
+        name =~ /^\#/ ? name : "##{name}"
+      end
+      alias chan channel_name
+      
+      def arguments(input)
+        prefix, ending = input.split(":", 2)
+        prefix = prefix.split(" ")
+        prefix << ending unless ending.blank?
+        return prefix
+      end
+
+      # Specifies the last parameter of a response, used to
+      # specify parameters which have spaces etc (for example,
+      # the actual message part of a response).
+      def last_param(section, ignore_prefix = true)
+        content = section.to_s.strip
+        return if content.blank?
+        if content =~ /\s+/ && (ignore_prefix || content !~ /^:/)
+          ":#{content}"
+        else
+          content
+        end
+      end
+      alias lp last_param
+      
+      # Converts a glob-like pattern into a regular
+      # expression for easy / fast matching. Code is
+      # from PLEAC at http://pleac.sourceforge.net/pleac_ruby/patternmatching.html
+      def glob2pattern(glob_string)
+          inner_pattern = glob_string.gsub(/(.)/) do |c|
+            GLOB_PATTERN_MAP[c] || Regexp::escape(c)
+          end
+        return Regexp.new("^#{inner_pattern}$")
+      end
+     
+      extend self
+     
+  end
+end

data/templates/boot.erb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'marvin'
+Marvin::Settings.root = Pathname.new(__FILE__).dirname.join("..").expand_path

data/templates/connections.yml.erb

@@ -0,0 +1,10 @@
+"irc.freenode.net":
+  port: 6667
+  channels:
+    - "#marvin-testing"
+
+"irc.oftc.net":
+  port: 6697
+  ssl: true
+  channels:
+    - "#marvin-testing"

data/templates/debug_handler.erb

@@ -0,0 +1,5 @@
+# Use this class to debug stuff as you 
+# go along - e.g. dump events etc.
+class DebugHandler < Marvin::CommandHandler
+    
+end

data/templates/hello_world.erb

@@ -0,0 +1,10 @@
+class HelloWorld < Marvin::CommandHandler
+  
+  exposes :hello
+  
+  desc "Says hello to you (with the current pid!)"
+  def hello(data)
+    reply "Hola from process with pid #{Process.pid}!"
+  end
+  
+end

data/templates/rakefile.erb

@@ -0,0 +1,15 @@
+require 'rake'
+require 'rake/testtask'
+
+task :default => "test:units"
+
+namespace :test do
+  
+  desc "Runs the unit tests for perennial"
+  Rake::TestTask.new("units") do |t|
+    t.pattern = 'test/*_test.rb'
+    t.libs << 'test'
+    t.verbose = true
+  end
+  
+end

data/templates/settings.yml.erb

@@ -0,0 +1,8 @@
+default:
+  user: MarvinBot
+  name: MarvinBot
+  nick: MarvinBot
+  nicks:
+    - MarvinBot1000
+    - MarvinBot2000
+    - MarvinBot3000

data/templates/setup.erb

@@ -0,0 +1,31 @@
+# Is loaded on setup / when handlers need to be
+# registered. Use it to register handlers / do
+# any repeatable setup that will happen before
+# any connections are created
+Marvin::Loader.before_run do
+  
+  # E.G.
+  # MyHandler.register! (Marvin::Base subclass) or
+  # Marvin::Settings.client.register_handler my_handler (a handler instance)
+  
+  # Register based on some setting you've added. e.g.:
+  # LoggingHandler.register! if Marvin::Settings.use_logging?
+  
+  # Conditional registration - load the distributed dispatcher
+  # if an actual client, otherwise use the normal handlers.
+  #
+  # if Marvin::Loader.distributed_client?
+  #   HelloWorld.register!
+  #   DebugHandler.register!
+  # else
+  #   Marvin::Distributed::Handler.register!
+  # else
+  
+  # end
+  
+  # And any other code here that will be run before the client, e.g:
+  
+  HelloWorld.register!
+  DebugHandler.register!
+  
+end

data/templates/test_helper.erb

@@ -0,0 +1,17 @@
+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("config", "boot")
+
+class Test::Unit::TestCase
+
+  # Add your extensions here
+  
+end

data/test/abstract_client_test.rb

@@ -0,0 +1,63 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class AbstractClientTest < Test::Unit::TestCase
+  
+  context 'testing out a connection' do
+
+    setup do
+      @client = Marvin::Settings.client
+      @client.setup
+      @config = @client.configuration
+      @client.configuration = {
+        :user  => "DemoUser",
+        :name  => "Demo Users Name",
+        :nick  => "Haysoos",
+        :nicks => ["Haysoos_", "Haysoos__"]
+      }
+    end
+    
+    should "dispatch :client_connected as the first event on process_connect" do
+      assert_resets_client
+      client.process_connect
+      assert_equal [:client_connected, {}], client.dispatched_events.first
+      assert_dispatched :client_connected, 0, {}
+    end
+
+    should "dispatch :client_connected as the first event on process_connect" do
+      assert_resets_client
+      client.default_channels = ["#awesome", "#rock"]
+      client.process_connect
+      assert_dispatched :client_connected, -2, {}
+      assert_dispatched :outgoing_nick,    -1
+      assert_equal 2, client.outgoing_commands.length
+      assert_equal "NICK Haysoos\r\n", client.outgoing_commands[0]
+      assert_sent_line "NICK Haysoos\r\n", 0
+      assert_sent_line "USER DemoUser 0 \* :Demo Users Name\r\n", 1
+    end
+
+    should "dispatch :client_disconnect on process_disconnect" do
+      assert_resets_client
+      client.process_disconnect
+      assert_dispatched :client_disconnected
+    end
+    
+    should 'attempt to join the default channels on receiving welcome' do
+      assert_resets_client
+      client.default_channels = ["#awesome", "#rock"]
+      client.handle_welcome
+      assert_sent_line "JOIN #awesome,#rock\r\n"
+    end
+
+    should "add an :incoming_line event for each incoming line" do
+      assert_resets_client
+      client.receive_line "SOME RANDOM LINE THAT HAS ZERO ACTUAL USE"
+      assert_dispatched :incoming_line, 0, :line => "SOME RANDOM LINE THAT HAS ZERO ACTUAL USE"
+    end
+    
+    teardown do
+      @client.configuration = @config
+    end
+    
+  end
+  
+end