cinch-test 0.0.2 → 0.0.3

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -1,8 +1,3 @@
 source 'http://rubygems.org'
 
 gemspec
-gem 'minitest'
-gem 'wrong'
-gem 'rake'
-gem 'rr'
-gem 'debugger'

data/README.md

@@ -0,0 +1,15 @@
+# Cinch::Test
+
+[![Gem Version](https://badge.fury.io/rb/cinch-test.png)](http://badge.fury.io/rb/cinch-test)
+[![Dependency Status](https://gemnasium.com/bhaberer/cinch-test.png)](https://gemnasium.com/bhaberer/cinch-test)
+[![Build Status](https://travis-ci.org/bhaberer/cinch-test.png?branch=master)](https://travis-ci.org/bhaberer/cinch-test)
+[![Coverage Status](https://coveralls.io/repos/bhaberer/cinch-test/badge.png?branch=master)](https://coveralls.io/r/bhaberer/cinch-test?branch=master)
+[![Code Climate](https://codeclimate.com/github/bhaberer/cinch-test.png)](https://codeclimate.com/github/bhaberer/cinch-test)
+
+## Usage
+
+1. `require 'cinch/test'` and include the module `Cinch::Test` in your test scope
+2. Make a bot with `make_bot(plugin, plugin_opts)` (you can pass a block to further configure the bot)
+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)`

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = Dir.glob('spec/**/*_spec.rb')
+  t.libs.push 'spec'
+end
+
+task :default => :test

data/cinch-test.gemspec

@@ -1,17 +1,29 @@
-require './lib/cinch/test/version'
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cinch/test/version'
 
-Gem::Specification.new do |s|
-  s.name = "cinch-test"
-  s.version = Cinch::Test.version
-  s.authors = ["Jay Adkisson"]
-  s.email = ["jay@jayferd.us"]
-  s.summary = "utility methods for testing Cinch bots"
-  s.description = <<-desc.strip.gsub(/\s+/, ' ')
-    A collection of utility methods for testing Cinch bots
-  desc
-  s.homepage = "http://github.com/jayferd/cinch-test"
-  s.rubyforge_project = "cinch-test"
-  s.files = Dir['Gemfile', 'cinch-test.gemspec', 'lib/**/*.rb']
+Gem::Specification.new do |gem|
+  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"
 
-  s.add_dependency 'cinch'
+  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.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'
 end

data/lib/cinch/test.rb

@@ -1,10 +1,7 @@
 require 'cinch'
-
 require 'pathname'
 require 'thread'
 
-load Pathname.new(__FILE__).dirname.join('test/version.rb')
-
 module Cinch
   module Test
     class MockIRC < Cinch::IRC
@@ -41,19 +38,19 @@ module Cinch
         # override the message-parsing stuff
         super(nil, bot)
         @message = msg
-        nick = opts.delete(:nick) { 'test' }
-        @bot.user_list.find_ensured(nil, nick, nil)
+        @user = Cinch::User.new(opts.delete(:nick) { 'test' }, bot)
+        @channel = Cinch::Channel.new(opts.delete(:channel), bot) if opts.key?(:channel)
 
-        @channel = opts.delete(:channel) { nil }
+        @bot.user_list.find_ensured(nil, @user.nick, nil)
       end
     end
 
-    def make_bot(plugin, opts, &b)
+    def make_bot(plugin, opts = {}, &b)
       MockBot.new do
         configure do |c|
           c.nick = 'testbot'
           c.server = nil
-          c.channels = []
+          c.channels = ['foo']
           c.plugins.plugins = [plugin]
           c.plugins.options[plugin] = opts
           c.reconnect = false
@@ -67,9 +64,21 @@ module Cinch
       MockMessage.new(text, bot, opts)
     end
 
-    def send_message(message, event=:message)
+    def send_message(message, event = :message)
       handlers = message.bot.handlers
-      handlers.dispatch(event, message)
+
+      # Deal with secondary event types
+      # 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 is :private also trigger :message
+      events << :message if events.include?(:private)
+
+      # Dispatch each of the events to the handlers
+      events.each { |e| handlers.dispatch(e, message) }
 
       # join all of the freaking threads, like seriously
       # why is there no option to dispatch synchronously
@@ -84,7 +93,8 @@ module Cinch
       replies = []
 
       (class << message; self; end).class_eval do
-        define_method :reply do |r|
+        define_method :reply do |r, prefix = false|
+          r = [self.user.nick, r].join(': ') if prefix
           mutex.synchronize { replies << r }
         end
       end

data/lib/cinch/test/version.rb

@@ -1,7 +1,5 @@
 module Cinch
   module Test
-    def self.version
-      '0.0.2'
-    end
+    VERSION = '0.0.3'
   end
 end

data/spec/cinch_test_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe Cinch::Test do
+  class MyPlugin
+    include Cinch::Plugin
+
+    attr_reader :foo
+    def initialize(*)
+      super
+      @foo = config[:foo]
+    end
+
+    match /foo/, :method => :foo
+    def foo(m)
+      m.reply "foo: #{@foo}"
+    end
+
+    match /bar/, :method => :bar
+    def bar(m)
+      m.reply 'bar reply'
+    end
+
+    match /baz/, :method => :baz
+    def baz(m)
+      m.reply 'baz reply', true
+    end
+
+    listen_to :channel
+    def listen(m)
+      m.reply 'I listen'
+    end
+
+    match /trout/, :method => :action, :react_on => :action
+    def action(m)
+      m.reply 'I hate fish'
+    end
+  end
+
+  include Cinch::Test
+
+  it 'makes a test bot without a config' do
+    bot = make_bot(MyPlugin)
+    assert bot.is_a?(Cinch::Bot)
+  end
+
+  let(:bot) { make_bot(MyPlugin, :foo => 'foo_value') }
+
+  it 'makes a test bot with a config' do
+    assert bot.is_a?(Cinch::Bot)
+  end
+
+  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']
+  end
+
+  describe '#make_message' do
+    let(:message) { make_message(bot, '!bar') }
+
+    it 'messages a test bot and gets a reply' do
+      replies = get_replies(message)
+      assert replies == ['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']
+    end
+  end
+
+  describe 'listeners' do
+    let(:message) { make_message(bot, 'blah blah blah', :channel => 'test') }
+
+    it 'messages a test bot and gets a prefixed reply' do
+      replies = get_replies(message)
+      assert replies == ['I listen']
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'cinch/test'
+require 'minitest'
+require 'minitest/autorun'
+require 'wrong/adapters/minitest'
+require 'rr'
+
+Wrong.config[:color] = true
+

metadata

@@ -1,25 +1,122 @@
 --- !ruby/object:Gem::Specification
 name: cinch-test
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
 - Jay Adkisson
+- Brian Haberer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-25 00:00:00.000000000 Z
+date: 2013-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: cinch
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: wrong
+  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: 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: 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'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -27,17 +124,40 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: A collection of utility methods for testing Cinch bots
+- !ruby/object:Gem::Dependency
+  name: cinch
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: A collection of utility methods, mocks and methods for testing Cinch
+  plugins
 email:
 - jay@jayferd.us
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- .travis.yml
 - Gemfile
+- README.md
+- Rakefile
 - cinch-test.gemspec
-- lib/cinch/test/version.rb
 - lib/cinch/test.rb
+- lib/cinch/test/version.rb
+- spec/cinch_test_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/jayferd/cinch-test
 licenses: []
 post_install_message: 
@@ -57,10 +177,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: cinch-test
-rubygems_version: 1.8.23
+rubyforge_project: 
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: utility methods for testing Cinch bots
-test_files: []
+summary: Helpers for testing Cinch Plugins
+test_files:
+- spec/cinch_test_spec.rb
+- spec/spec_helper.rb
 has_rdoc: