Sutto-marvin 0.4.0 → 0.8.0.0

data/lib/marvin/parsers/ragel_parser.rb

@@ -1,5 +1,9 @@
-# line 1 "lib/marvin/parsers/ragel_parser.rl"
-# line 107 "lib/marvin/parsers/ragel_parser.rl"
+
+# line 1 "ragel_parser.rl"
+# Ragel Parser comes from the Arrbot Guys - Kudos to Halogrium and Epitron.
+
+
+# line 109 "ragel_parser.rl"
 
 
 module Marvin
@@ -7,7 +11,7 @@ module Marvin
     class RagelParser < Marvin::AbstractParser
       
       
-# line 11 "lib/marvin/parsers/ragel_parser.rb"
+# line 15 "ragel_parser.rb"
 class << self
 	attr_accessor :_irc_actions
 	private :_irc_actions, :_irc_actions=
@@ -434,7 +438,8 @@ class << self
 end
 self.irc_en_main = 1;
 
-# line 114 "lib/marvin/parsers/ragel_parser.rl"
+
+# line 116 "ragel_parser.rl"
       
       private
       
@@ -448,18 +453,19 @@ self.irc_en_main = 1;
         hostmask = nil
         server   = nil
         code     = nil
-        command  = Marvin::Parsers::Command.new(data)
+        command  = Command.new(data)
 
         
-# line 462 "lib/marvin/parsers/ragel_parser.rb"
+# line 460 "ragel_parser.rb"
 begin
 	p ||= 0
 	pe ||= data.length
 	cs = irc_start
 end
-# line 137 "lib/marvin/parsers/ragel_parser.rl"
+
+# line 132 "ragel_parser.rl"
         
-# line 470 "lib/marvin/parsers/ragel_parser.rb"
+# line 469 "ragel_parser.rb"
 begin
 	_klen, _trans, _keys, _acts, _nacts = nil
 	_goto_level = 0
@@ -541,139 +547,139 @@ begin
 			_acts += 1
 			case _irc_actions[_acts - 1]
 when 0 then
-# line 4 "lib/marvin/parsers/ragel_parser.rl"
+# line 6 "ragel_parser.rl"
 		begin
 
-    server = Marvin::Parsers::Prefixes::Server.new
+    server = Prefixes::Server.new
   		end
-# line 4 "lib/marvin/parsers/ragel_parser.rl"
+# line 6 "ragel_parser.rl"
 when 1 then
-# line 8 "lib/marvin/parsers/ragel_parser.rl"
+# line 10 "ragel_parser.rl"
 		begin
 
     server.name << data[p]
   		end
-# line 8 "lib/marvin/parsers/ragel_parser.rl"
+# line 10 "ragel_parser.rl"
 when 2 then
-# line 12 "lib/marvin/parsers/ragel_parser.rl"
+# line 14 "ragel_parser.rl"
 		begin
 
     command.prefix = server
   		end
-# line 12 "lib/marvin/parsers/ragel_parser.rl"
+# line 14 "ragel_parser.rl"
 when 3 then
-# line 16 "lib/marvin/parsers/ragel_parser.rl"
+# line 18 "ragel_parser.rl"
 		begin
 
-    hostmask =  Marvin::Parsers::Prefixes::HostMask.new
+    hostmask =  Prefixes::HostMask.new
   		end
-# line 16 "lib/marvin/parsers/ragel_parser.rl"
+# line 18 "ragel_parser.rl"
 when 4 then
-# line 20 "lib/marvin/parsers/ragel_parser.rl"
+# line 22 "ragel_parser.rl"
 		begin
 
-    hostmask.nickname << data[p]
+    hostmask.nick << data[p]
   		end
-# line 20 "lib/marvin/parsers/ragel_parser.rl"
+# line 22 "ragel_parser.rl"
 when 5 then
-# line 24 "lib/marvin/parsers/ragel_parser.rl"
+# line 26 "ragel_parser.rl"
 		begin
 
     hostmask.user << data[p]
   		end
-# line 24 "lib/marvin/parsers/ragel_parser.rl"
+# line 26 "ragel_parser.rl"
 when 6 then
-# line 28 "lib/marvin/parsers/ragel_parser.rl"
+# line 30 "ragel_parser.rl"
 		begin
 
     hostmask.host << data[p]
   		end
-# line 28 "lib/marvin/parsers/ragel_parser.rl"
+# line 30 "ragel_parser.rl"
 when 7 then
-# line 32 "lib/marvin/parsers/ragel_parser.rl"
+# line 34 "ragel_parser.rl"
 		begin
 
     command.prefix = hostmask
   		end
-# line 32 "lib/marvin/parsers/ragel_parser.rl"
+# line 34 "ragel_parser.rl"
 when 8 then
-# line 36 "lib/marvin/parsers/ragel_parser.rl"
+# line 38 "ragel_parser.rl"
 		begin
 
     code = ""
   		end
-# line 36 "lib/marvin/parsers/ragel_parser.rl"
+# line 38 "ragel_parser.rl"
 when 9 then
-# line 40 "lib/marvin/parsers/ragel_parser.rl"
+# line 42 "ragel_parser.rl"
 		begin
 
     code << data[p]
   		end
-# line 40 "lib/marvin/parsers/ragel_parser.rl"
+# line 42 "ragel_parser.rl"
 when 10 then
-# line 44 "lib/marvin/parsers/ragel_parser.rl"
+# line 46 "ragel_parser.rl"
 		begin
 
     command.code = code
   		end
-# line 44 "lib/marvin/parsers/ragel_parser.rl"
+# line 46 "ragel_parser.rl"
 when 11 then
-# line 48 "lib/marvin/parsers/ragel_parser.rl"
+# line 50 "ragel_parser.rl"
 		begin
 
     params_1 = []
     params_2 = []
   		end
-# line 48 "lib/marvin/parsers/ragel_parser.rl"
+# line 50 "ragel_parser.rl"
 when 12 then
-# line 53 "lib/marvin/parsers/ragel_parser.rl"
+# line 55 "ragel_parser.rl"
 		begin
 
   		end
-# line 53 "lib/marvin/parsers/ragel_parser.rl"
+# line 55 "ragel_parser.rl"
 when 13 then
-# line 56 "lib/marvin/parsers/ragel_parser.rl"
+# line 58 "ragel_parser.rl"
 		begin
 
     params_1 << ""
   		end
-# line 56 "lib/marvin/parsers/ragel_parser.rl"
+# line 58 "ragel_parser.rl"
 when 14 then
-# line 60 "lib/marvin/parsers/ragel_parser.rl"
+# line 62 "ragel_parser.rl"
 		begin
 
     params_2 << ""
   		end
-# line 60 "lib/marvin/parsers/ragel_parser.rl"
+# line 62 "ragel_parser.rl"
 when 15 then
-# line 64 "lib/marvin/parsers/ragel_parser.rl"
+# line 66 "ragel_parser.rl"
 		begin
 
     params_1.last << data[p]
   		end
-# line 64 "lib/marvin/parsers/ragel_parser.rl"
+# line 66 "ragel_parser.rl"
 when 16 then
-# line 68 "lib/marvin/parsers/ragel_parser.rl"
+# line 70 "ragel_parser.rl"
 		begin
 
     params_2.last << data[p]
   		end
-# line 68 "lib/marvin/parsers/ragel_parser.rl"
+# line 70 "ragel_parser.rl"
 when 17 then
-# line 72 "lib/marvin/parsers/ragel_parser.rl"
+# line 74 "ragel_parser.rl"
 		begin
 
     command.params = params_1
   		end
-# line 72 "lib/marvin/parsers/ragel_parser.rl"
+# line 74 "ragel_parser.rl"
 when 18 then
-# line 76 "lib/marvin/parsers/ragel_parser.rl"
+# line 78 "ragel_parser.rl"
 		begin
 
     command.params = params_2
   		end
-# line 76 "lib/marvin/parsers/ragel_parser.rl"
-# line 684 "lib/marvin/parsers/ragel_parser.rb"
+# line 78 "ragel_parser.rl"
+# line 683 "ragel_parser.rb"
 			end # action switch
 		end
 	end
@@ -699,12 +705,13 @@ when 18 then
 	end
 	end
 	end
-# line 138 "lib/marvin/parsers/ragel_parser.rl"
+
+# line 133 "ragel_parser.rl"
 
         if cs >= irc_first_final
           command
         else
-          raise UnparseableMessage, "Failed to parse the message: #{input.inspect}"
+          raise UnparseableMessage, "Failed to parse the message: #{line.strip}"
         end
       end
       

data/lib/marvin/parsers/ragel_parser.rl

@@ -1,11 +1,10 @@
-# Ragel Parser comes from the Arrbot Guys -
-# Kudos to Halogrium and Epitron.
+# Ragel Parser comes from the Arrbot Guys - Kudos to Halogrium and Epitron.
 
 %%{
   machine irc;
   
   action prefix_servername_start {
-    server = Marvin::Parsers::Prefixes::Server.new
+    server = Prefixes::Server.new
   }
   
   action prefix_servername {
@@ -17,11 +16,11 @@
   }
   
   action prefix_hostmask_start {
-    hostmask =  Marvin::Parsers::Prefixes::HostMask.new
+    hostmask =  Prefixes::HostMask.new
   }
   
   action hostmask_nickname {
-    hostmask.nickname << fc
+    hostmask.nick << fc
   }
   
   action hostmask_user {
@@ -127,7 +126,7 @@ module Marvin
         hostmask = nil
         server   = nil
         code     = nil
-        command  = Marvin::Parsers::Command.new(data)
+        command  = Command.new(data)
 
         %% write init;
         %% write exec;
@@ -135,7 +134,7 @@ module Marvin
         if cs >= irc_first_final
           command
         else
-          raise UnparseableMessage, "Failed to parse the message: #{input.inspect}"
+          raise UnparseableMessage, "Failed to parse the message: #{line.strip}"
         end
       end
       

data/lib/marvin/parsers/simple_parser.rb

@@ -7,17 +7,12 @@ module Marvin
       # Parses an incoming message by using string
       # Manipulation.
       def self.parse!(line)
-        if line[0] == ?:
-          prefix_text, line = line.split(" ", 2)
-        else
-          prefix_text = nil
-        end
-        command = Marvin::Parsers::Command.new(line + "\r\n")
+        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)
-        head, tail = line.split(":", 2)
-        parts = head.split(" ")
+        parts = Marvin::Util.arguments(line)
         command.code = parts.shift
-        parts << tail unless tail.nil?
         command.params = parts
         return command
       end

data/lib/marvin/parsers.rb

@@ -1,10 +1,9 @@
 module Marvin
   module Parsers
     # Default Parsers
-    autoload :RegexpParser, 'marvin/parsers/regexp_parser'
-    autoload :SimpleParser, 'marvin/parsers/simple_parser'
     autoload :Prefixes,     'marvin/parsers/prefixes'
     autoload :Command,      'marvin/parsers/command'
+    autoload :SimpleParser, 'marvin/parsers/simple_parser'
     autoload :RagelParser,  'marvin/parsers/ragel_parser'
   end
 end

data/lib/marvin/settings.rb

@@ -1,81 +1,31 @@
-require 'yaml'
-require 'eventmachine'
-
-module Marvin
-  class Settings
-    
-    cattr_accessor :environment, :configuration, :is_setup, :default_client, :distributed_namespace,
-                   :handler_folder, :default_parser, :log_level, :verbose, :daemon
-                   
-    self.verbose   = false
-    self.log_level = :info
-    self.daemon    = false
-    
-    class << self
-      
-      def daemon?
-        self.daemon
-      end
-      
-      def root
-        File.expand_path(defined?(MARVIN_ROOT) ? MARVIN_ROOT : File.dirname(__FILE__) / "../..")
-      end
-      
-      def setup(options = {})
-        return if self.is_setup
-        self.setup!(options)
-      end
-      
-      def distributed_namespace
-        @@distributed_namespace ||= :default
-      end
-      
-      def setup!(options = {})
-        self.environment ||= "development"
-        self.configuration = {}
-        self.default_client ||= Marvin::IRC::Client
-        self.default_parser ||= Marvin::Parsers::SimpleParser
-        loaded_yaml = YAML.load_file(root / "config/settings.yml")
-        env_settings = loaded_yaml[self.environment] || {}
-        loaded_options = loaded_yaml["default"].merge(env_settings).merge(options)
-        self.configuration.merge!(loaded_options)
-        self.configuration.symbolize_keys!
-        mod = Module.new do
-          Settings.configuration.keys.each do |k|
-            define_method(k) do
-              return Settings.configuration[k]
-            end
-          
-            define_method("#{k}=") do |val|
-              Settings.configuration[k] = val
-            end
-          end
-        end
-        
-        # Extend and include.
-        
-        extend  mod
-        include mod
-        
-        self.is_setup = true
-      end
-      
-      def [](key)
-        self.setup
-        return self.configuration[key.to_sym]
-      end
-      
-      def []=(key, value)
-        self.setup
-        self.configuration[key.to_sym] = value
-        return value
-      end
-      
-      def to_hash
-        self.configuration
-      end
-      
-    end
-
+# 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

@@ -1,63 +1,57 @@
-require 'ostruct'
-require 'active_support'
-
 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
+    
+    attr_accessor :incoming_commands, :outgoing_commands, :last_sent,
+                  :dispatched_events, :connection_open
     
     cattr_accessor :instances
-    self.instances = []
+    @@instances = []
     
     DispatchedEvents = Struct.new(:name, :options)
     
     def initialize(opts = {})
       super
-      self.incoming_commands = []
-      self.outgoing_commands = []
-      self.dispatched_events = []
-      self.connection_open   = false
-      self.instances << self
+      @incoming_commands = []
+      @outgoing_commands = []
+      @dispatched_events = []
+      @connection_open   = false
+      @@instances << self
     end
     
     def connection_open?
-      self.connection_open
+      !!@connection_open
     end
     
     def send_line(*args)
-      self.outgoing_commands += args
-      self.last_sent = args.last
+      @outgoing_commands += args
+      @last_sent = args.last
     end
     
     def test_command(name, *args)
-      options = args.extract_options!
+      options   = args.extract_options!
       host_mask = options.delete(:host_mask) || ":WiZ!jto@tolsun.oulu.fi"
-      name = name.to_s.upcase
-      args = args.flatten.compact
-      irc_command = "#{host_mask} #{name} #{args.join(" ").strip}"
-      self.receive_line irc_command
+      name      = name.to_s.upcase
+      args      = args.flatten.compact
+      receive_line "#{host_mask} #{name} #{args.join(" ").strip}"
     end
     
     def dispatch(name, opts = {})
-      self.dispatched_events << [name, opts]
+      @dispatched_events << [name, opts]
       super(name, opts)
     end
     
     def self.run
-      self.instances.each do |i|
-        i.connection_open = true
-      end
+      @@instances.each { |i| i.connection_open = true }
     end
     
     def self.stop
-      self.instances.each do |i|
-        i.connection_open = false
-      end
+      @@instances.each { |i| i.connection_open = false }
     end
     
     def self.add_reconnect(opts = {})
-      Marvin::Logger.info "Added reconnect with options: #{opts.inspect}"
+      logger.info "Added reconnect with options: #{opts.inspect}"
     end
     
   end

data/lib/marvin/util.rb

@@ -12,7 +12,8 @@ module Marvin
       # appending "#" to the front if it doesn't already
       # start with it.
       def channel_name(name)
-        return name.to_s[0..0] == "#" ? name.to_s : "##{name}"
+        name = name.to_s
+        name =~ /^\#/ ? name : "##{name}"
       end
       alias chan channel_name
       
@@ -26,8 +27,14 @@ module Marvin
       # 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)
-        section && ":#{section.to_s.strip}"
+      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
       

data/lib/marvin.rb

@@ -1,53 +1,56 @@
-$:.unshift File.dirname(__FILE__) # Append the current working dir to the front of the line.
-
+$LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rubygems'
-require 'active_support'
-require 'marvin/core_ext'
-
-# Make all exceptions available
-require 'marvin/exceptions'
+require 'perennial'
 
 module Marvin
-  module VERSION
-    MAJOR = 0
-    MINOR = 3
-    PATCH = 2
-    
-    STRING = [MAJOR, MINOR, PATCH].join(".")
-  end
+  include Perennial
+  
+  VERSION = [0, 8, 0, 0]
   
-  autoload :Util,             'marvin/util'
-  autoload :Dispatchable,     'marvin/dispatchable'
+  # Misc.
+  #autoload :Util,             'marvin/util'
+  # Client
+  #autoload :AbstractClient,   'marvin/abstract_client'
+  #autoload :IRC,              'marvin/irc'
+  autoload :TestClient,       'marvin/test_client'
+  # Console of DOOM.
+  autoload :Console,          'marvin/console'
+  # Distributed
   autoload :Distributed,      'marvin/distributed'
-  autoload :AbstractClient,   'marvin/abstract_client'
+  autoload :Status,           'marvin/status'
+  # Handler
   autoload :Base,             'marvin/base'
-  autoload :Console,          'marvin/console'
-  autoload :CoreCommands,     'marvin/core_commands'
-  autoload :ClientMixin,      'marvin/client_mixin'
-  autoload :Settings,         'marvin/settings'
-  autoload :Logger,           'marvin/logger'
+  autoload :CommandHandler,   'marvin/command_handler'
   autoload :LoggingHandler,   'marvin/logging_handler'
-  autoload :IRC,              'marvin/irc'
-  autoload :TestClient,       'marvin/test_client'
-  autoload :Loader,           'marvin/loader'
+  autoload :CoreCommands,     'marvin/core_commands'
   autoload :MiddleMan,        'marvin/middle_man'
-  autoload :DRBHandler,       'marvin/drb_handler'
-  autoload :DataStore,        'marvin/data_store'
-  autoload :ExceptionTracker, 'marvin/exception_tracker'
-  autoload :Options,          'marvin/options'
-  autoload :Daemon,           'marvin/daemon'
-  autoload :Status,           'marvin/status'
-  # Parsers
-  autoload :AbstractParser,   'marvin/abstract_parser'
-  autoload :Parsers,          'marvin/parsers.rb'
+  # These should be namespaced under IRC
+  #autoload :AbstractParser,   'marvin/abstract_parser'
+  autoload :Parsers,          'marvin/parsers'
   
-  # Default Handlers
-  autoload :CommandHandler, 'marvin/command_handler'
   
-  Settings.setup # Load Settings etc.
+  manifest do |m, l|
+    Settings.root = File.dirname(File.dirname(__FILE__))
+    l.register_controller :client,             'Marvin::Settings.client'
+    l.register_controller :console,            'Marvin::Console'
+    l.register_controller :distributed_client, 'Marvin::Distributed::Client'
+    # Core Commands handily makes available a set
+    # of information about what is running etc.
+    
+    l.before_run do
+      if l.distributed_client?
+        Marvin::Settings.client = Marvin::Distributed::Client 
+      end
+    end
+    
+  end
   
-  def self.version
-    VERSION::STRING
+  def self.version(include_minor = false)
+    VERSION[0, (include_minor ? 4 : 3)].join(".")
   end
   
+  has_library :util, :abstract_client, :abstract_parser, :irc, :exception_tracker
+  
+  extends_library :settings
+  
 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