ircbgb 0.0.1.pre

data/spec/ircbgb/user_spec.rb

@@ -0,0 +1,72 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Ircbgb::User do
+  describe "parsing" do
+    it "parses a `nick!user@host` string" do
+      user = Ircbgb::User.parse('my_nick!~stuffit@some.exotic.host')
+      user.nick.must_equal 'my_nick'
+      user.user.must_equal '~stuffit'
+      user.host.must_equal 'some.exotic.host'
+    end
+
+    it "parses a wildcarded string" do
+      user = Ircbgb::User.parse('*!?stuffy@*.example.???')
+      user.nick.must_equal '*'
+      user.user.must_equal '?stuffy'
+      user.host.must_equal '*.example.???'
+    end
+
+    it "parses missing bits, wildcarding what's left out" do
+      user = Ircbgb::User.parse('beeboz')
+      user.nick.must_equal 'beeboz'
+      user.user.must_equal '*'
+      user.host.must_equal '*'
+      user = Ircbgb::User.parse('booboz!@host')
+      user.nick.must_equal 'booboz'
+      user.user.must_equal '*'
+      user.host.must_equal 'host'
+    end
+
+    it "parses a user as itself" do
+      user = Ircbgb::User.parse('my_nick!~stuffit@some.exotic.host')
+      Ircbgb::User.parse(user).must_equal user
+    end
+  end
+
+  describe "methods" do
+    it "converts to a string" do
+      user = Ircbgb::User.new('a_nick', 'a_username', 'a.host.example.org')
+      user.to_s.must_equal 'a_nick!a_username@a.host.example.org'
+      Ircbgb::User.parse('nick').to_s.must_equal 'nick!*@*'
+    end
+  end
+
+  describe "matching" do
+    def match_me; @match_me ||= Ircbgb::User.new('someNick', '~stuffy', 'britches.co.uk'); end
+    
+    it "matches against IRC wildcard strings" do
+      'someNick!~stuffy@britches.co.uk'.must_match match_me
+      '*o*!*stuffy@*i*.?o.u?'.must_match match_me
+      'S???nick!*~stuffy@britches.co.**'.must_match match_me
+      '*!*@*'.must_match match_me
+      '?*'.must_match match_me
+      'someNick?!*@*'.wont_match match_me
+      '*b*!*@*'.wont_match match_me
+      '*q*'.wont_match match_me
+    end
+    
+    it "matches against regexs" do
+      /\Asome/.must_match match_me
+      /stuffy@bri/.must_match match_me
+      /\AsomeNick.!/.wont_match match_me
+      /.*b.*!.*@.*/.wont_match match_me
+      /q/.wont_match match_me
+    end
+
+    it "matches against matchers" do
+      Ircbgb::Matcher.new('*o*!*stuffy@*i*.?o.u?').must_match match_me
+      Ircbgb::Matcher.new('someNick?!*@*').wont_match match_me
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+if ENV['SCOV']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter "/spec/"
+  end
+end
+
+begin
+  require 'minitest/autorun'
+  require 'minitest/emoji'
+rescue LoadError
+end
+
+Dir[File.expand_path('../support/*.rb', __FILE__)].each do |r|
+  require r
+end
+
+require 'ircbgb'

data/spec/support/dummy_io.rb

@@ -0,0 +1,70 @@
+require 'stringio'
+
+# Used to test IO stuff, using stringio objects for the write and
+# read stream.
+class DummyIO
+  attr_reader :closed, :w_stream, :r_stream, :raised_write, :raised_read
+  alias :closed? :closed
+  alias :raised_write? :raised_write
+  alias :raised_read? :raised_read
+  attr_accessor :readable, :writeable
+  attr_accessor :write_delay, :read_delay
+  attr_accessor :max_write, :max_read
+  attr_accessor :raise_read, :raise_write
+  alias :readable? :readable
+  alias :writeable? :writeable
+  
+  def initialize *args, &block
+    @r_stream = StringIO.new
+    @w_stream = StringIO.new
+    @readable = @writeable = true
+    @read_delay = @write_delay = 0
+    @max_write = 0
+    @max_read = 0
+    @closed = false
+    @raise_read = nil
+    @raise_write = nil
+    @raised_write = false
+    @raised_read = false
+  end
+  
+  def close
+    @closed = true
+    @w_stream.close
+    @r_stream.close
+  end
+  
+  def write_nonblock bytes
+    sleep(@write_delay) if @write_delay > 0
+    do_raise_write
+    if @max_write > 0 && bytes.size > @max_write
+      @w_stream.write bytes[0...@max_write]
+    else
+      @w_stream.write bytes
+    end
+  end
+  
+  def read_nonblock len
+    sleep(@read_delay) if @read_delay > 0
+    do_raise_read
+    if @max_read > 0 && len > @max_read
+      @r_stream.read @max_read
+    else
+      @r_stream.read len
+    end
+  end
+
+  def do_raise_write
+    if @raise_write
+      @raised_write = true
+      raise @raise_write
+    end
+  end
+
+  def do_raise_read
+    if @raise_read
+      @raised_read = true
+      raise @raise_read
+    end
+  end
+end

data/spec/support/stubz.rb

@@ -0,0 +1,49 @@
+module Stubz
+  def self.included base
+    base.__send__(:before) { _ensure_stubs_ }
+    base.__send__(:after) { _reset_stubs_ }
+  end
+
+  def stub_instance(klass, meth, *val, &block)
+    _do_stub_ klass, meth, *val, &block
+  end
+
+  def stub(obj, meth, *val, &block)
+    _do_stub_ get_meta_class(obj), meth, *val, &block
+  end
+
+  def get_meta_class klass
+    class << klass; self; end
+  end
+
+  def _do_stub_ klass, meth, *val, &block
+    if klass.method_defined? meth
+      aliased = "_stub_#{meth}_#{Time.now.to_i}_"
+      klass.send(:alias_method, aliased, meth)
+    else
+      aliased = nil
+    end
+    if block
+      klass.send(:define_method, meth, &block)
+    else
+      klass.send(:define_method, meth) do |*_|
+        val.first
+      end
+    end
+    @stubbies << [klass, meth, aliased]
+  end
+
+  def _ensure_stubs_
+    @stubbies = []
+  end
+
+  def _reset_stubs_
+    @stubbies.each do |(klass, meth, aliased)|
+      klass.send(:remove_method, meth)
+    if aliased
+      klass.send(:alias_method, meth, aliased)
+      klass.send(:remove_method, aliased)
+    end
+    end
+  end
+end

data/spec/support/unblocked_tcp_socket.rb

@@ -0,0 +1,60 @@
+# Rather than using IoUnblock with a mock TCPSocket, we'll trust IoUnblock to
+# test itself properly, and mock out IoUnblock::TcpSocket instead.
+class UnblockedTcpSocket
+  attr_reader :host, :port, :callbacks, :written
+
+  def initialize
+    @written = []
+  end
+
+  def init_with host, port, callbacks=nil
+    @callbacks = callbacks || {}
+    @host = host
+    @port = port
+    @callbacks[:callback_failed] ||= lambda { |ex|
+      warn "Default callback_failed handler: #{ex}"
+    }
+    self
+  end
+
+  def start; self; end
+  def stop; self; end
+  def running?; true; end
+
+  def server_write_raw str
+    @callbacks[:read] && @callbacks[:read].call(str)
+  end
+
+  def server_write cmd, max_len=nil
+    server_write_raw ":#{@host} #{cmd}\r\n"
+  end
+
+  def write str
+    if str[-2..-1] != "\r\n"
+      raise "You forgot to CRLF your message"
+    end
+    @written << str[0..-3]
+  end
+
+  def trigger_start
+    trigger_ev :started, :start
+  end
+
+  def trigger_loop
+    trigger_ev :looped, self
+  end
+
+  def trigger_stop
+    trigger_ev :stopped, :stop
+  end
+
+  def trigger_ev ev, *args
+    @callbacks[ev] && @callbacks[ev].call(*args)
+  rescue Exception
+    if ev != :callback_failed
+      @callbacks[:callback_failed].call($!)
+    else
+      warn "Your callback failure callback is raising errors: #{$!}"
+    end
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: ircbgb
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+  prerelease: 6
+platform: ruby
+authors:
+- Ian D. Eccles
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-14 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2156987900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156987900
+description: An IRC client library geared toward writing custom clients and bots
+email:
+- ian.eccles@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .autotest
+- .gitignore
+- Gemfile
+- Rakefile
+- ircbgb.gemspec
+- lib/ircbgb.rb
+- lib/ircbgb/behaviors.rb
+- lib/ircbgb/behaviors/negotiates_connection.rb
+- lib/ircbgb/behaviors/provides_commands.rb
+- lib/ircbgb/client.rb
+- lib/ircbgb/errors.rb
+- lib/ircbgb/matcher.rb
+- lib/ircbgb/message.rb
+- lib/ircbgb/message_parser.rb
+- lib/ircbgb/message_parser.rl
+- lib/ircbgb/server.rb
+- lib/ircbgb/user.rb
+- lib/ircbgb/version.rb
+- spec/ircbgb/client_spec.rb
+- spec/ircbgb/matcher_spec.rb
+- spec/ircbgb/message_parser_spec.rb
+- spec/ircbgb/message_spec.rb
+- spec/ircbgb/user_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy_io.rb
+- spec/support/stubz.rb
+- spec/support/unblocked_tcp_socket.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: ircbgb
+rubygems_version: 1.8.12
+signing_key: 
+specification_version: 3
+summary: An IRC client library
+test_files:
+- spec/ircbgb/client_spec.rb
+- spec/ircbgb/matcher_spec.rb
+- spec/ircbgb/message_parser_spec.rb
+- spec/ircbgb/message_spec.rb
+- spec/ircbgb/user_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy_io.rb
+- spec/support/stubz.rb
+- spec/support/unblocked_tcp_socket.rb
+has_rdoc: