cinch-test 0.0.3 → 0.0.4

data/README.md

@@ -13,3 +13,13 @@
 3. Make a message with `make_message(bot, 'message text')`
 4. Stub things out on the message as you like, then collect all the replies
    with `get_replies(message)`
+
+## Changelog
+* 0.0.3
+    * [Bug Fix] Initializing plugins without a config hash works now.
+    * [Bug Fix] MockMessage objects now have a real Cinch::User / Cinch::Channel object
+        instead of strings.
+    * [Bug Fix] MockMessages with a channel set will also be processed as a :channel event.
+    * [Bug Fix] MockMessages of :private events will now also be processed as :message
+    * [Bug Fix] All MockMessages will now be processed in as a :catchall event type in
+        addition to other specified types.

data/lib/cinch/test.rb

@@ -5,7 +5,7 @@ require 'thread'
 module Cinch
   module Test
     class MockIRC < Cinch::IRC
-      def initialize(*)
+      def initialize(*args)
         super
         # the #setup method adds the @network property among
         # other things
@@ -20,7 +20,7 @@ module Cinch
     end
 
     class MockBot < Cinch::Bot
-      def initialize(*)
+      def initialize(*args)
         super
         @irc = MockIRC.new(self)
 
@@ -34,7 +34,7 @@ module Cinch
     end
 
     class MockMessage < Cinch::Message
-      def initialize(msg, bot, opts={})
+      def initialize(msg, bot, opts = {})
         # override the message-parsing stuff
         super(nil, bot)
         @message = msg
@@ -45,6 +45,8 @@ module Cinch
       end
     end
 
+    Reply = Struct.new(:text, :event, :time)
+
     def make_bot(plugin, opts = {}, &b)
       MockBot.new do
         configure do |c|
@@ -60,11 +62,62 @@ module Cinch
       end
     end
 
-    def make_message(bot, text, opts={})
+    def make_message(bot, text, opts = {})
       MockMessage.new(text, bot, opts)
     end
 
-    def send_message(message, event = :message)
+    # Process message and return all replies.
+    # @parmam [Cinch::Test::MockMessage] message A MockMessage object.
+    # @param [Symbol] event The event type of the message.
+    def get_replies(message, event = :message)
+      mutex = Mutex.new
+      replies = []
+
+      # Catch all m.reply
+      (class << message; self; end).class_eval do
+        define_method :reply do |msg, prefix = false|
+          msg = [self.user.nick, msg].join(': ') if prefix
+          r = Reply.new(msg, :message, Time.now)
+          mutex.synchronize { replies << r }
+        end
+      end
+
+      # Catch all user.(msg|send|privmsg)
+      (class << message.user; self; end).class_eval do
+        [:send, :msg, :privmsg].each do |method|
+          define_method method do |msg, notice = false|
+            r = Reply.new(msg, (notice ? :notice : :private), Time.now)
+            mutex.synchronize { replies << r }
+          end
+        end
+      end
+
+      # Catch all channel.send and action
+      if message.channel
+        (class << message.channel; self; end).class_eval do
+          define_method :send do |msg, notice = false|
+            r = Reply.new(msg, :channel, Time.now)
+            mutex.synchronize { replies << r }
+          end
+
+          define_method :action do |msg, notice = false|
+            r = Reply.new(msg, :action, Time.now)
+            mutex.synchronize { replies << r }
+          end
+        end
+      end
+
+      process_message(message, event)
+
+      replies
+    end
+
+    private
+
+    # Process message by dispatching it to the handlers
+    # @param [Cinch::Test::MockMessage] message A MockMessage object.
+    # @param [Symbol] event The event type of the message.
+    def process_message(message, event)
       handlers = message.bot.handlers
 
       # Deal with secondary event types
@@ -86,22 +139,5 @@ module Cinch
         handler.thread_group.list.each(&:join)
       end
     end
-
-    def get_replies(message, event=:message)
-      mutex = Mutex.new
-
-      replies = []
-
-      (class << message; self; end).class_eval do
-        define_method :reply do |r, prefix = false|
-          r = [self.user.nick, r].join(': ') if prefix
-          mutex.synchronize { replies << r }
-        end
-      end
-
-      send_message(message, event)
-
-      replies
-    end
   end
 end

data/lib/cinch/test/version.rb

@@ -1,5 +1,5 @@
 module Cinch
   module Test
-    VERSION = '0.0.3'
+    VERSION = '0.0.4'
   end
 end

data/spec/cinch_test_spec.rb

@@ -10,30 +10,45 @@ describe Cinch::Test do
       @foo = config[:foo]
     end
 
-    match /foo/, :method => :foo
+    match /foo/, method: :foo
     def foo(m)
       m.reply "foo: #{@foo}"
     end
 
-    match /bar/, :method => :bar
+    match /bar/, method: :bar
     def bar(m)
       m.reply 'bar reply'
     end
 
-    match /baz/, :method => :baz
+    match /baz/, method: :baz
     def baz(m)
       m.reply 'baz reply', true
     end
 
-    listen_to :channel
-    def listen(m)
-      m.reply 'I listen'
+    listen_to :channel, method: :chan_listen
+    def chan_listen(m)
+      m.reply 'I listen' if m.message == 'blah'
     end
 
-    match /trout/, :method => :action, :react_on => :action
+    match /trout/, method: :action, react_on: :action
     def action(m)
       m.reply 'I hate fish'
     end
+
+    match /ping/, method: :ping
+    def ping(m)
+      m.channel.send 'Pong?'
+    end
+
+    match /dance/, method: :dance
+    def dance(m)
+      m.channel.action 'DANCES'
+    end
+
+    match /message/, method: :message
+    def message(m)
+      m.user.send 'a message!'
+    end
   end
 
   include Cinch::Test
@@ -52,33 +67,50 @@ describe Cinch::Test do
   it 'makes a bot with config values available to the plugin' do
     message = make_message(bot, '!foo')
     replies = get_replies(message)
-    assert replies == ['foo: foo_value']
+    assert replies.first.text == 'foo: foo_value'
   end
 
-  describe '#make_message' do
-    let(:message) { make_message(bot, '!bar') }
+  describe 'message events' do
 
     it 'messages a test bot and gets a reply' do
+      message = make_message(bot, '!bar')
       replies = get_replies(message)
-      assert replies == ['bar reply']
+      assert replies.first.text == 'bar reply'
     end
-  end
 
-  describe '#make_message with reply' do
     let(:message) { make_message(bot, '!baz') }
 
     it 'messages a test bot and gets a prefixed reply' do
       replies = get_replies(message)
-      assert replies == ['test: baz reply']
+      assert replies.first.text == 'test: baz reply'
     end
   end
 
-  describe 'listeners' do
-    let(:message) { make_message(bot, 'blah blah blah', :channel => 'test') }
+  describe 'user events' do
+    it 'captures messages sent to users' do
+      r = get_replies(make_message(bot, '!message', :channel => '#test')).first
+      assert r.text == 'a message!'
+      assert r.event == :private
+    end
+  end
 
-    it 'messages a test bot and gets a prefixed reply' do
+  describe 'channel events' do
+    it 'get triggered by channel events' do
+      message = make_message(bot, 'blah', :channel => 'test')
       replies = get_replies(message)
-      assert replies == ['I listen']
+      assert replies.first.text == 'I listen'
+    end
+
+    it 'captures channel messages' do
+      r = get_replies(make_message(bot, '!ping', :channel => '#test')).first
+      assert r.text == 'Pong?'
+      assert r.event == :channel
+    end
+
+    it 'captures a channel action' do
+      r = get_replies(make_message(bot, '!dance', :channel => '#test')).first
+      assert r.text == 'DANCES'
+      assert r.event == :action
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,11 @@
 require 'coveralls'
-Coveralls.wear!
+require 'simplecov'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start 'rails'
 
 require 'cinch/test'
 require 'minitest'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cinch-test
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-29 00:00:00.000000000 Z
+date: 2013-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake