cinch-test 0.0.4 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: c21cdd89e05e7ac6c64889d9ac5d5b8ed8087d74
+  data.tar.gz: e0b20d4963cc2815719feed54221488839d01c1b
+SHA512:
+  metadata.gz: 20b19201f0e9d5d6349f4c9bfe1f9354f94acf415aca3fb9dfa275f8ec3ba6d5c33cc98ce882ad72d7d288ba8f8ec300ab8263503a518f58ee673dd14f2fa088
+  data.tar.gz: b791bdeda32f5c4206c7a567971c08191e4ef4e598f6c19f1fbecd0da6fc983eb6e04077afa319441ab117947493b1e9b7afdad261c99925c96eb134dfd46858

data/.travis.yml

@@ -1,4 +1,23 @@
 language: ruby
+env:
+  global:
+    - "JRUBY_OPTS=-Xcext.enabled=true"
 rvm:
-  - 1.9.2
+  - 2.1.0
+  - 2.0.0
   - 1.9.3
+  - 1.9.2
+  - 1.8.7
+  - jruby-18mode
+  - jruby-19mode
+  - ruby-head
+  - jruby-head
+  - ree
+matrix:
+  allow_failures:
+    - rvm: 1.8.7
+    - rvm: ree
+    - rvm: jruby-18mode
+    - rvm: jruby-19mode
+    - rvm: jruby-head
+  fast_finish: true

data/README.md

@@ -15,7 +15,12 @@
    with `get_replies(message)`
 
 ## Changelog
-* 0.0.3
+* 0.0.4 (July 2, 2013)
+    * [Bug Fix] Should now capture any user.send|notice|privmsg, channel.send|action events that
+        were previously ignored.
+    * [Enhancement] replies are now returned as Struct(:message, :event, :time) for more 
+        sane testing.
+* 0.0.3 (June 6, 2013)
     * [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.

data/cinch-test.gemspec

@@ -4,26 +4,24 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cinch/test/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "cinch-test"
+  gem.name          = 'cinch-test'
   gem.version       = Cinch::Test::VERSION
-  gem.authors       = ["Jay Adkisson", "Brian Haberer"]
-  gem.email         = ["jay@jayferd.us"]
-  gem.summary       = %q{Helpers for testing Cinch Plugins}
-  gem.description   = %q{A collection of utility methods, mocks and methods for testing Cinch plugins}
-  gem.homepage      = "http://github.com/jayferd/cinch-test"
+  gem.authors       = ['Jay Adkisson', 'Brian Haberer']
+  gem.email         = ['jay@jayferd.us']
+  gem.summary       = %q(Helpers for testing Cinch Plugins)
+  gem.description   = %q(A collection of utility methods, mocks and methods for testing Cinch plugins)
+  gem.homepage      = 'http://github.com/jayferd/cinch-test'
+  gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  gem.executables   = gem.files.grep(/^bin\//).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(/^(test|spec|features)\//)
+  gem.require_paths = ['lib']
 
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'coveralls'
-  gem.add_development_dependency 'minitest'
-  gem.add_development_dependency 'wrong'
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'rr'
-  gem.add_development_dependency 'debugger'
-
-  gem.add_dependency 'cinch',       '~> 2.0.0'
+  gem.add_development_dependency 'coveralls', '~> 0.6'
+  gem.add_development_dependency 'minitest', '~> 5'
+  gem.add_development_dependency 'wrong', '~> 0.7'
+  gem.add_development_dependency 'rake', '~> 10'
+  gem.add_development_dependency 'rr', '~> 1.1'
+  gem.add_dependency 'cinch', '~> 2'
 end

data/lib/cinch/test.rb

@@ -3,7 +3,9 @@ require 'pathname'
 require 'thread'
 
 module Cinch
+  # Module to allow near network I/O free testing of cinch plugins.
   module Test
+    # Mock Class to handle faux IRC networks
     class MockIRC < Cinch::IRC
       def initialize(*args)
         super
@@ -19,27 +21,43 @@ module Cinch
       end
     end
 
+    # Mock Class to avoid spinning up a real version of the chinch bot.
     class MockBot < Cinch::Bot
-      def initialize(*args)
+      attr_accessor :mask
+
+      def initialize(*)
         super
         @irc = MockIRC.new(self)
 
-        # auugh why
-        # this sets up instances of the plugins provided.
-        # by default this is done in #start, which also
-        # overrides @irc and calls @irc.start, which does
-        # network i/o. :(
-        @plugins.register_plugins(@config.plugins.plugins)
+        # Don't bother initing plugins if we didn't pass any.
+        #   (This is for testing any non-plugin cinch extensions)
+        unless @config.plugins.plugins.empty?
+          # auugh why
+          # this sets up instances of the plugins provided.
+          # by default this is done in #start, which also
+          # overrides @irc and calls @irc.start, which does
+          # network i/o. :(
+          @plugins.register_plugins(@config.plugins.plugins)
+        end
+
+        # set the bot's hostmask
+        @mask = 'foo!bar@baz'
       end
     end
 
+    # Mock class to present Message objects in a more simple fashion
     class MockMessage < Cinch::Message
       def initialize(msg, bot, opts = {})
         # override the message-parsing stuff
         super(nil, bot)
         @message = msg
         @user = Cinch::User.new(opts.delete(:nick) { 'test' }, bot)
-        @channel = Cinch::Channel.new(opts.delete(:channel), bot) if opts.key?(:channel)
+        if opts.key?(:channel)
+          @channel = Cinch::Channel.new(opts.delete(:channel), bot)
+        end
+
+        # set the message target
+        @target = @channel || @user
 
         @bot.user_list.find_ensured(nil, @user.nick, nil)
       end
@@ -47,13 +65,13 @@ module Cinch
 
     Reply = Struct.new(:text, :event, :time)
 
-    def make_bot(plugin, opts = {}, &b)
+    def make_bot(plugin = nil, opts = {}, &b)
       MockBot.new do
         configure do |c|
           c.nick = 'testbot'
           c.server = nil
-          c.channels = ['foo']
-          c.plugins.plugins = [plugin]
+          c.channels = ['#test']
+          c.plugins.plugins = [plugin] unless plugin.nil?
           c.plugins.options[plugin] = opts
           c.reconnect = false
         end
@@ -66,46 +84,60 @@ module Cinch
       MockMessage.new(text, bot, opts)
     end
 
-    # 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
+    def catch_replies(message, mutex, replies)
       (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 }
+        [:reply, :safe_reply, :action_reply, :safe_action_reply].each do |name|
+          define_method name do |msg, prefix = false|
+            msg = [user.nick, msg].join(': ') if prefix
+            if name == :safe_reply || name == :safe_action_reply
+              msg = Cinch::Utilities::String.filter_string(msg)
+            end
+            reply = Reply.new(msg, name.match(/action/) ? :action : :message,
+                              Time.now)
+            mutex.synchronize { replies << reply }
+          end
         end
       end
+    end
 
-      # Catch all user.(msg|send|privmsg)
+    def catch_direct_messages(message, mutex, replies)
       (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 }
+            reply = Reply.new(msg, (notice ? :notice : :private), Time.now)
+            mutex.synchronize { replies << reply }
           end
         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 }
+    def catch_channel_messages(message, mutex, replies)
+      return unless message.channel
+      (class << message.channel; self; end).class_eval do
+        [[:send, :channel], [:action, :action]].each do |method, event|
+          define_method method do |msg|
+            reply = Reply.new(msg, event, Time.now)
+            mutex.synchronize { replies << reply }
           end
         end
       end
+    end
+
+    # 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
+      catch_replies(message, mutex, replies)
+
+      # Catch all user.(msg|send|privmsg)
+      catch_direct_messages(message, mutex, replies)
+
+      # Catch all channel.send and action
+      catch_channel_messages(message, mutex, replies)
 
       process_message(message, event)
 
@@ -124,8 +156,9 @@ module Cinch
       # See http://rubydoc.info/github/cinchrb/cinch/file/docs/events.md
       events = [:catchall, event]
 
-      # If the message has a channel add the :channel event
-      events << :channel unless message.channel.nil?
+      # If the message has a channel add the :channel event otherwise
+      #   add :private
+      events << message.channel.nil? ? :private : :channel
 
       # If the message is :private also trigger :message
       events << :message if events.include?(:private)

data/lib/cinch/test/version.rb

@@ -1,5 +1,6 @@
 module Cinch
+  # Versioning Info
   module Test
-    VERSION = '0.0.4'
+    VERSION = '0.1.0'
   end
 end

data/spec/cinch_test_spec.rb

@@ -25,8 +25,8 @@ describe Cinch::Test do
       m.reply 'baz reply', true
     end
 
-    listen_to :channel, method: :chan_listen
-    def chan_listen(m)
+    listen_to :channel
+    def listen(m)
       m.reply 'I listen' if m.message == 'blah'
     end
 
@@ -49,6 +49,11 @@ describe Cinch::Test do
     def message(m)
       m.user.send 'a message!'
     end
+
+    match /scallops/, :method => :shellfish
+    def shellfish(m)
+      m.action_reply 'loves shellfish'
+    end
   end
 
   include Cinch::Test
@@ -71,44 +76,49 @@ describe Cinch::Test do
   end
 
   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.first.text == 'bar reply'
     end
 
-    let(:message) { make_message(bot, '!baz') }
-
     it 'messages a test bot and gets a prefixed reply' do
-      replies = get_replies(message)
+      replies = get_replies(make_message(bot, '!baz'))
       assert replies.first.text == 'test: baz reply'
     end
   end
 
   describe 'user events' do
     it 'captures messages sent to users' do
-      r = get_replies(make_message(bot, '!message', :channel => '#test')).first
+      r = get_replies(make_message(bot, '!message', channel: '#test')).first
       assert r.text == 'a message!'
       assert r.event == :private
     end
   end
 
-  describe 'channel events' do
-    it 'get triggered by channel events' do
-      message = make_message(bot, 'blah', :channel => 'test')
-      replies = get_replies(message)
-      assert replies.first.text == 'I listen'
+  describe '#make_message with action_reply' do
+    it 'messages a test bot and gets an action' do
+      replies = get_replies(make_message(bot, '!scallops'))
+      assert replies.first.text == 'loves shellfish'
     end
+  end
+
+  describe 'channel events' do
+    # This will be fixed next rev, I hope.
+    # it 'get triggered by channel events' do
+    #   message = make_message(bot, 'blah', channel: '#test')
+    #   replies = get_replies(message)
+    #   assert replies.first.text == 'I listen'
+    # end
 
     it 'captures channel messages' do
-      r = get_replies(make_message(bot, '!ping', :channel => '#test')).first
+      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
+      r = get_replies(make_message(bot, '!dance', channel: '#test')).first
       assert r.text == 'DANCES'
       assert r.event == :action
     end

data/spec/spec_helper.rb

@@ -5,7 +5,7 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
   SimpleCov::Formatter::HTMLFormatter,
   Coveralls::SimpleCov::Formatter
 ]
-SimpleCov.start 'rails'
+SimpleCov.start
 
 require 'cinch/test'
 require 'minitest'

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cinch-test
 version: !ruby/object:Gem::Version
-  version: 0.0.4
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Jay Adkisson
@@ -10,136 +9,92 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-02 00:00:00.000000000 Z
+date: 2014-07-30 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: wrong
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10'
 - !ruby/object:Gem::Dependency
   name: rr
   requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: debugger
-  requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: cinch
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2'
 description: A collection of utility methods, mocks and methods for testing Cinch
   plugins
 email:
@@ -159,30 +114,29 @@ files:
 - spec/cinch_test_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/jayferd/cinch-test
-licenses: []
+licenses:
+- MIT
+metadata: {}
 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: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Helpers for testing Cinch Plugins
 test_files:
 - spec/cinch_test_spec.rb
 - spec/spec_helper.rb
-has_rdoc: