Sutto-marvin 0.4.0 → 0.8.0.0

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/{config/setup.rb → templates/setup.erb}

@@ -4,16 +4,12 @@
 # any connections are created
 Marvin::Loader.before_run do
   
-  # Want a non-default namespace? Choose something simple
-  # Marvin::Settings.distributed_namespace = :some_namespace
-  
   # E.G.
   # MyHandler.register! (Marvin::Base subclass) or
-  # Marvin::Settings.default_client.register_handler my_handler (a handler instance)
+  # Marvin::Settings.client.register_handler my_handler (a handler instance)
   
-  # Register in ruby
-  #
-  # LoggingHandler.register! if Marvin::Settings.use_logging
+  # 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.
@@ -22,12 +18,14 @@ Marvin::Loader.before_run do
   #   HelloWorld.register!
   #   DebugHandler.register!
   # else
-  #   Marvin::Distributed::DispatchHandler.register!
+  #   Marvin::Distributed::Handler.register!
+  # else
+  
   # end
   
-  # And any other code here that will be run before the client
+  # And any other code here that will be run before the client, e.g:
   
   HelloWorld.register!
   DebugHandler.register!
   
-end
+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

data/test/parser_comparison.rb

@@ -12,7 +12,7 @@ LINES = [
   ":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::RagelParser, Marvin::Parsers::SimpleParser, Marvin::Parsers::RegexpParser]
+PARSERS = [Marvin::Parsers::SimpleParser, Marvin::Parsers::RagelParser]
 
 LINES.each do |line|
   
@@ -44,7 +44,7 @@ puts ""
 
 width = PARSERS.map { |p| p.name.length }.max + 2
 
-ITERATIONS = 1000
+ITERATIONS = 100
 
 Benchmark.bm(width) do |b|
   PARSERS.each do |parser|

data/test/parser_test.rb

@@ -8,7 +8,7 @@ require File.join(File.dirname(__FILE__), 'test_helper')
 class ParserTest < Test::Unit::TestCase
   
   # The default parser
-  @@parser = Marvin::Parsers::SimpleParser
+  @@parser = Marvin::Settings.parser
   
   context "When parsing a LIST" do
     setup { @parsed = @@parser.new("LIST #twilight_zone,#42") }
@@ -79,7 +79,7 @@ class ParserTest < Test::Unit::TestCase
     end
     
     should "have the correct nick" do
-      assert_equal "RelayBot", @parsed.command.prefix.nickname
+      assert_equal "RelayBot", @parsed.command.prefix.nick
     end
     
     should "have the correct user" do
@@ -136,7 +136,7 @@ class ParserTest < Test::Unit::TestCase
     end
     
     should "have the correct nick" do
-      assert_equal "SuttoL", @parsed.command.prefix.nickname
+      assert_equal "SuttoL", @parsed.command.prefix.nick
     end
     
     should "have the correct user" do

data/test/test_helper.rb

@@ -1,10 +1,62 @@
-BASE_DIR = File.expand_path(File.join(File.dirname(__FILE__), ".."))
-
 require 'rubygems'
-require 'shoulda'
+
+# Testing dependencies
 require 'test/unit'
-require File.join(BASE_DIR, "lib/marvin")
+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
-  # Any extra helpers go here
-end
+
+  @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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Sutto-marvin
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.8.0.0
 platform: ruby
 authors: 
 - Darcy Laycock
@@ -9,140 +9,113 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-22 00:00:00 -07:00
-default_executable: marvin
+date: 2009-09-16 00:00:00 -07:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: json
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: activesupport
+  name: Sutto-perennial
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.1.0
+        version: 0.2.4.6
     version: 
 - !ruby/object:Gem::Dependency 
-  name: eventmachine
+  name: eventmachine-eventmachine
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.12.0
+        version: 0.12.9
     version: 
 - !ruby/object:Gem::Dependency 
-  name: thor
+  name: json
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.9.7
+        version: "0"
     version: 
-description: Marvin is a Ruby IRC library / framework for ultimate awesomeness and with an evented design.
+description: 
 email: sutto@sutto.net
-executables: 
-- marvin
+executables: []
+
 extensions: []
 
-extra_rdoc_files: 
-- README.textile
+extra_rdoc_files: []
+
 files: 
-- README.textile
-- TUTORIAL.textile
-- VERSION.yml
 - bin/marvin
-- config/boot.rb
-- config/connections.yml.sample
-- config/settings.yml.sample
-- config/setup.rb
-- handlers/debug_handler.rb
-- handlers/hello_world.rb
-- handlers/logging_handler.rb
-- handlers/simple_logger.rb
-- handlers/tweet_tweet.rb
-- lib/marvin.rb
+- lib/marvin
 - lib/marvin/abstract_client.rb
 - lib/marvin/abstract_parser.rb
 - lib/marvin/base.rb
+- lib/marvin/client
+- lib/marvin/client/actions.rb
+- lib/marvin/client/default_handlers.rb
 - lib/marvin/command_handler.rb
 - lib/marvin/console.rb
 - lib/marvin/core_commands.rb
-- lib/marvin/core_ext.rb
-- lib/marvin/daemon.rb
-- lib/marvin/data_store.rb
-- lib/marvin/dispatchable.rb
+- lib/marvin/distributed
+- lib/marvin/distributed/client.rb
+- lib/marvin/distributed/handler.rb
+- lib/marvin/distributed/protocol.rb
+- lib/marvin/distributed/server.rb
 - lib/marvin/distributed.rb
-- lib/marvin/distributed/dispatch_handler.rb
-- lib/marvin/distributed/drb_client.rb
-- lib/marvin/distributed/ring_server.rb
+- lib/marvin/dsl.rb
 - lib/marvin/exception_tracker.rb
 - lib/marvin/exceptions.rb
-- lib/marvin/handler.rb
-- lib/marvin/irc.rb
+- lib/marvin/irc
 - lib/marvin/irc/client.rb
 - lib/marvin/irc/event.rb
 - lib/marvin/irc/replies.rb
-- lib/marvin/irc/server.rb
-- lib/marvin/irc/server/abstract_connection.rb
-- lib/marvin/irc/server/base_connection.rb
-- lib/marvin/irc/server/channel.rb
-- lib/marvin/irc/server/named_store.rb
-- lib/marvin/irc/server/remote_interface.rb
-- lib/marvin/irc/server/user.rb
-- lib/marvin/irc/server/user/handle_mixin.rb
-- lib/marvin/irc/server/user_connection.rb
-- lib/marvin/irc/server/virtual_user_connection.rb
-- lib/marvin/loader.rb
-- lib/marvin/logger.rb
+- lib/marvin/irc.rb
 - lib/marvin/logging_handler.rb
 - lib/marvin/middle_man.rb
-- lib/marvin/options.rb
-- lib/marvin/parsers.rb
+- lib/marvin/parsers
 - lib/marvin/parsers/command.rb
-- lib/marvin/parsers/prefixes.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.rb
+- lib/marvin/parsers.rb
 - lib/marvin/settings.rb
-- lib/marvin/status.rb
 - lib/marvin/test_client.rb
 - lib/marvin/util.rb
-- script/client
-- script/console
-- script/distributed_client
-- script/install
-- script/ring_server
-- script/server
-- script/status
-- spec/marvin/abstract_client_test.rb
-- spec/spec_helper.rb
+- lib/marvin.rb
+- templates/boot.erb
+- templates/connections.yml.erb
+- templates/debug_handler.erb
+- templates/hello_world.erb
+- templates/rakefile.erb
+- templates/settings.yml.erb
+- templates/setup.erb
+- templates/test_helper.erb
+- test/abstract_client_test.rb
 - test/parser_comparison.rb
 - test/parser_test.rb
 - test/test_helper.rb
 - test/util_test.rb
+- handlers/debug_handler.rb
+- handlers/hello_world.rb
+- handlers/keiki_thwopper.rb
+- handlers/simple_logger.rb
+- handlers/tweet_tweet.rb
 has_rdoc: false
-homepage: http://blog.ninjahideout.com/
+homepage: http://sutto.net/
 licenses: 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -163,11 +136,6 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Ruby IRC Library / Framework
-test_files: 
-- spec/marvin/abstract_client_test.rb
-- spec/spec_helper.rb
-- test/parser_comparison.rb
-- test/parser_test.rb
-- test/test_helper.rb
-- test/util_test.rb
+summary: Evented IRC Library of Doom
+test_files: []
+

data/README.textile

@@ -1,105 +0,0 @@
-h1. Marvin
-
-Marvin is a ruby irc framework / library built on top of event machine.
-It's been build from scratch to be evented - you build "handlers" which
-are called whenever an event occurs.
-
-A single client instance can handle multiple IRC connections (and will
-automatically reconnect in the case that a connection is lost). Distributed
-support (e.g. 1 client => multiple handler backends) is built in out of
-the box on top of DRb.
-
-h2. Getting Started
-
-Starting out with Marvin is simple. You can either go the "edge" route -
-cloning from the GitHub repository (in this case, [here](http://github.com/sutto/marvin))
-and then running the following:
-
-  $ rake gemspec
-  $ gem build marvin.gemspec
-  $ sudo gem install marvin.gem
-
-Or, for a generally more stable release you can install it from the GitHub gem
-server (requiring Rubygems >= 1.2.0 with the GitHub sources added), by running
-the following:
-
-  $ sudo gem install Sutto-marvin
-  
-Installing the gem will make available a new executable - "+marvin+" - which is
-used as an easy way to do a variety of tasks. To get started, you can create
-a project located at given path using the following command:
-
-  $ marvin create path-to-my-bot
-  
-Once that's done, you'll have a blank slate loaded with the default marvin handlers -
-+HelloWorld+ (which will respond to any addressed "hello"'s) and an empty debug handler
-which you can use for generic debugging. To run the new app, you can use either of the
-following:
-
-  $ cd path-to-my-bot && script/client
-  
-or, alternatively,
-
-  $ marvin client path-to-my-bot
-  
-There are a couple of options available for the client (as well as the marvin library),
-Each of which can be found by appending the "--help" option to the command.
-
-Once your client has been started (assuming the name wasn't taken / it could connect),
-simply join the chat room your bot was instructed to join and say the following (substiting
-BotNick for the nick name your bot connected with):
-
-  BotNick: hello
-  
-Or even easier, by PM'ing the bot with:
-
-  hello
-  
-Assuming all went well, your bot should reply back with something akin to (where YourNick)
-if the nickname you connected with):
-
-  YourNick: Hola from process with pid 12342
-
-h2. Distributed Bots
-
-One of the relatively unique features of Marvin is the ability to write bots
-which use DRb and Rinda which can grow with relative ease.
-
-It's important to keep in mind that keeping state is discouraged in this case
-as it can not be ensured that clients are still active or that you will always
-get messages from the same client.
-
-For a start, take a look at the default +config/setup.rb+ file which contains
-an example of registering handlers on a distributed client as well as setting
-up the distributed handler which needs to be setup on the main client.
-
-By default, the messages will be dispatched to the first discovered tuple
-space (using Rinda::RingFinger) and will be of the format:
-
-  [:marvin_format, :your_namespace, :message_name, {:message => "options"}, client_reference]
-  
-You can change the namespace (which defaults to +:default+) by setting +Marvin::Settings.distributed_namespace+
-
-Running a distributed client requires three things:
-
-* 1 Ring server instance (+script/ring_server+ or +marvin ring_server+ or +marvin rs+)
-* 1+ Client instances (+script/client+ or +marvin client+ or +marvin cl+)
-* 1+ Distributed Client instances (+script/distributed_client+ or +marvin distributed_client+ or +marvin dc+)
-
-Each of which takes the default options of:
-* -v - Be verbose and print to STDOUT if not daemonized
-* -level=something - set level, defaults to info
-* -d - daemonize the process
-* -k - kill all daemonized instances of this specific kind
-
-h2. Example Bots
-
-Coming soon.
-
-h2. Thanks
-
-Thanks go to:
-
-* Jeff Rafter - contributed code and doc changes, now one of the co-developers.
-* epitron / halogrium - For the ragel state machine used in Marvin::Parsers::RagelParser
-* The creator of Ruby-IRCD - the server component is heavily influenced by / part derivative of said work.

data/TUTORIAL.textile

@@ -1,54 +0,0 @@
-h1. A Quick Introduction to Marvin
-
-Welcome young one - in today's lesson we're going to learn
-how to build a simple IRC bot using "Marvin":http://github.com/Sutto/marvin.
-If you haven't built an IRC bot before, there is a great
-deal of things you can do - ranging from consuming content (e.g.
-analysing logs of IRC rooms, seeing who swears the most)
-as well as other things such as bridges between other
-protocols (twitter => irc bridges) and all sorts of fancy stuff.
-
-h3. What is this marvin thingy-majiggy?
-
-Marvin is an IRC Library / Framework (it can be used either way)
-built with an evented design on top of DRb, EventMachine and a bunch
-of other stuff for Ruby. it's currently got a fairly complete client
-and a very incomplete server implementation.
-
-h2. Step #1 - Getting Marvin
-
-There are currently two different ways to get marvin - via the
-GitHub gem sources or directly from the source.
-
-To install from the GitHub gem source, simply use:
-
-  sudo gem install Sutto-marvin -s http://gems.github.com
-  
-Alternatively, you can directly clone the repository. To do this, you'll need to run the
-following:
-
-  git clone git://github.com/Sutto/marvin.git
-  cd marvin
-  sudo ./script/install
-  
-Once that's done, not only will you now have a handy "marvin" gem which you
-can require but you will also have a handy executable of the same name which
-you can use.
-
-h2. Step #2 - Creating a Skeleton App
-
-By default, marvin currently uses a simple skeleton app (not unlike
-Ruby on Rails) as a starting point. To get started, you simply use
-the "marvin create" command with a path to / folder name (which must not
-yet exist) into which you wish to create the folder. For example, if I wanted
-to create a new irc bot called "BlorkBot", I could do the following:
-
-  marvin create BlorkBot
-  
-And a new directory with the basic structure called "BlorkBot" will be created
-under the current directory. To get started, you can then open your editor and
-browse the given folder. Of this generated structure, there are only two folders
-you need to worry about for the moment - config and handlers.
-
-h2. Step #3 - Basic configuration
-  

data/VERSION.yml

@@ -1,4 +0,0 @@
---- 
-:minor: 4
-:patch: 0
-:major: 0

data/config/boot.rb

@@ -1,14 +0,0 @@
-# Load Marvin, do any initialization etc.
-# Note: this is called from inside scripts
-# or anywhere you want to start a base marvin
-# instance.
-
-require 'rubygems'
-
-MARVIN_ROOT = File.expand_path(File.join(File.dirname(__FILE__), ".."))
-
-# Check if a local copy of marvin exists, and set the load path if it does.
-$:.unshift(File.dirname(__FILE__) + "/../lib/") if File.exist?(File.dirname(__FILE__) + "/../lib/marvin.rb")
-
-# And Require Marvin.
-require 'marvin'

data/config/connections.yml.sample

@@ -1,5 +0,0 @@
-"irc.freenode.net":
-    port: 6667
-    channels:
-      - "#marvin-testing"
-      - "#relayrelay"

data/config/settings.yml.sample

@@ -1,13 +0,0 @@
-default:
-  name: Marvin
-  use_logging: false
-  datastore_location: tmp/datastore.json
-  nicks:
-    - MarvinBot1000
-    - MarvinBot2000
-    - MarvinBot3000
-    - MarvinusBoticus
-development:
-  user: MarvinBot
-  name: MarvinBot
-  nick: MarvinBot