cinch 0.3.2 → 0.3.5

data/lib/cinch.rb

@@ -7,9 +7,10 @@ require 'optparse'
 require 'cinch/irc'
 require 'cinch/rules'
 require 'cinch/base'
+require 'cinch/names'
 
 module Cinch
-  VERSION = '0.3.2'
+  VERSION = '0.3.5'
 
   class << self
 

data/lib/cinch/irc/parser.rb

@@ -59,7 +59,7 @@ module Cinch
         add_pattern :ip4addr, /\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}/
         add_pattern :ip6addr, /[\dA-Fa-f](?::[\dA-Fa-f]){7}|0:0:0:0:0:(?:0|[Ff]{4}):#{pattern(:ip4addr)}/
         add_pattern :hostaddr, /#{pattern(:ip4addr)}|#{pattern(:ip6addr)}/
-        add_pattern :shortname, /[A-Za-z0-9][A-Za-z0-9-]*/
+        add_pattern :shortname, /[A-Za-z0-9][A-Za-z0-9\-\/]*/
         add_pattern :hostname, /#{pattern(:shortname)}(?:\.#{pattern(:shortname)})*/
         add_pattern :host, /#{pattern(:hostname)}|#{pattern(:hostaddr)}/
 

data/lib/cinch/names.rb

@@ -0,0 +1,54 @@
+module Cinch
+  module Names
+    attr_reader :channel_names
+    
+    def tracking_names?
+      !!@tracking_names
+    end
+    
+    def track_names
+      return if tracking_names?
+      
+      @tracking_names = true
+      
+      @channel_names = {}
+      
+      on(:join) do |m|
+        if m.nick == nick
+          names(m.channel)
+        else
+          channel_names[m.channel] ||= []
+          channel_names[m.channel].push m.nick
+        end
+      end
+      
+      on(353) do |m|
+        channel = m.params.detect { |c|  c.match(/^#/) }
+        names   = m.text.split.collect { |n|  n.sub(/^@/, '') }
+        channel_names[channel] ||= []
+        channel_names[channel] += names
+      end
+      
+      on(:part) do |m|
+        if m.nick == nick
+          channel_names.delete(m.channel)
+        else
+          channel_names[m.channel] ||= []
+          channel_names[m.channel].delete m.nick
+        end
+      end
+      
+      on(:quit, :kill) do |m|
+        channel_names.each_value { |names|  names.delete m.nick }
+      end
+      
+      on(:nick) do |m|
+        channel_names.each_value { |names|  names.push m.recipient if names.delete m.nick }
+      end
+    end
+  end
+end
+
+class Cinch::Base
+  include Cinch::Names
+end

data/spec/base_spec.rb

@@ -11,24 +11,7 @@ describe "Cinch::Base" do
     )
   end
 
-  describe "::new" do 
-    it "should add a default ping listener" do
-      @base.listeners.should include :ping
-    end
-
-    it "should add a default nick-taken listener" do
-      @base.listeners.should include :"433"
-    end
-
-    it "should add a 004 listener, only if channels are set" do
-      @base.listeners.should_not include :'004'
-      @full.listeners.should include :'004'
-    end
-
-    it "should add a 433 nick taken listener" do
-      @base.listeners.should include :'433'
-    end
-    
+  describe "::new" do     
     it "should add a ctcp version listener" do 
       @base.listeners.should include :ctcp
       @base.listeners[:ctcp].should include :version

data/spec/names_spec.rb

@@ -0,0 +1,393 @@
+require File.dirname(__FILE__) + '/helper'
+
+describe Cinch::Base do
+  before :each do
+    @bot = Cinch::Base.new
+  end
+  
+  it 'should be able to track names' do
+    @bot.should respond_to(:track_names)
+  end
+  
+  describe 'when tracking names' do
+    before :each do
+      @bot.track_names
+    end
+    
+    it 'should indicate it is tracking names' do
+      @bot.tracking_names?.should == true
+    end
+    
+    it 'should provide access to the stored channel names' do
+      @bot.should respond_to(:channel_names)
+    end
+    
+    it 'should initialize the stored channel names as a hash' do
+      @bot.channel_names.should == {}
+    end
+    
+    it 'should provide a join listener' do
+      @bot.listeners[:join].should_not be_nil
+    end
+    
+    describe 'join listener' do
+      before :each do
+        @listener = @bot.listeners[:join].first
+        @message = Struct.new(:nick, :channel).new('someguy', '#somechan')
+        
+        @bot.instance_variable_set('@channel_names', { @message.channel => [] })
+      end
+      
+      it 'should be callable' do
+        @listener.should respond_to(:call)
+      end
+      
+      it "should add the joiner's nick to the channel name list" do
+        @listener.call(@message)
+        @bot.channel_names[@message.channel].should == [@message.nick]
+      end
+      
+      it "should not remove any already-present nicks in the channel name list" do
+        nicks = %w[tom mary joe]
+        @bot.instance_variable_set('@channel_names', { @message.channel => nicks.dup })
+        @listener.call(@message)
+        @bot.channel_names[@message.channel].sort.should == (nicks + [@message.nick]).sort
+      end
+      
+      it 'should not affect any other channel name lists' do
+        channel_names = { '#otherchan' => %w[some people], @message.channel => [] }
+        @bot.instance_variable_set('@channel_names', channel_names.dup)
+        @listener.call(@message)
+        @bot.channel_names.should == { '#otherchan' => %w[some people], @message.channel => [@message.nick] }
+      end
+      
+      it 'should handle the channel names not already tracking the channel' do
+        @bot.instance_variable_set('@channel_names', {})
+        @listener.call(@message)
+        @bot.channel_names[@message.channel].should == [@message.nick]
+      end
+      
+      it 'should not issue a names command to the channel' do
+        @bot.should_receive(:names).never
+        @listener.call(@message)
+      end
+      
+      describe 'and the joiner is the bot' do
+        before :each do
+          @message.nick = @bot.nick
+        end
+        
+        it 'should not add the nick to the name list' do
+          @listener.call(@message)
+          @bot.channel_names[@message.channel].should_not include(@message.nick)
+        end
+        
+        it 'should issue a names command to the channel' do
+          @bot.should_receive(:names).with(@message.channel)
+          @listener.call(@message)
+        end
+      end
+    end
+    
+    it 'should provide a names listener' do
+      @bot.listeners[:'353'].should_not be_nil
+    end
+    
+    describe 'names listener' do
+      before :each do
+        @listener = @bot.listeners[:'353'].first
+        @nick_text = 'cardroid admc cldwalker bmizerany'
+        @nicks = %w[cardroid admc cldwalker bmizerany]
+        @channel = '#github'
+        @message = Struct.new(:params, :text).new(['cardroid', '@', @channel, @nick_text], @nick_text)
+      end
+      
+      it 'should be callable' do
+        @listener.should respond_to(:call)
+      end
+      
+      it 'should set the channel name list to the given nick list' do
+        @listener.call(@message)
+        @bot.channel_names[@channel].should == @nicks
+      end
+      
+      it 'should add the given nicks to an already-present channel name list' do
+        nicks = %w[other people already present]
+        @bot.instance_variable_set('@channel_names', { @channel => nicks.dup })
+        
+        @listener.call(@message)
+        @bot.channel_names[@channel].should == (nicks + @nicks)
+      end
+      
+      it 'should not affect any other channel name lists' do
+        channel_names = { '#otherchan' => %w[some people], @channel => [] }
+        @bot.instance_variable_set('@channel_names', channel_names.dup)
+        @listener.call(@message)
+        @bot.channel_names.should == { '#otherchan' => %w[some people], @channel => @nicks }
+      end
+      
+      it 'should strip extra marking characters from the given nick list' do
+        nick_text = 'cardroid admc cldwalker bmizerany programble @luckiestmonkey @tekkub binjured ceej'
+        nicks = %w[cardroid admc cldwalker bmizerany programble luckiestmonkey tekkub binjured ceej]
+        @message.params[-1] = nick_text
+        @message.text       = nick_text
+        
+        @listener.call(@message)
+        @bot.channel_names[@channel].should == nicks
+      end
+    end
+
+    it 'should provide a part listener' do
+      @bot.listeners[:part].should_not be_nil
+    end
+    
+    describe 'part listener' do
+      before :each do
+        @listener = @bot.listeners[:part].first
+        @message = Struct.new(:nick, :channel).new('someguy', '#somechan')
+        
+        @bot.instance_variable_set('@channel_names', { @message.channel => [] })
+      end
+      
+      it 'should be callable' do
+        @listener.should respond_to(:call)
+      end
+      
+      it "should remove the parter's nick from the channel name list" do
+        @nicks = %w[bunch of people]
+        @bot.instance_variable_set('@channel_names', { @message.channel => (@nicks + [@message.nick]) })
+        
+        @listener.call(@message)
+        @bot.channel_names[@message.channel].should == @nicks
+      end
+      
+      it "should remove the parter's nick from the channel name list no matter where or how many times it occurs" do
+        @nicks = %w[bunch of people]
+        @bot.instance_variable_set('@channel_names', { @message.channel => @nicks.join(" #{@message.nick} ").split })
+        
+        @listener.call(@message)
+        @bot.channel_names[@message.channel].should == @nicks
+      end
+      
+      it 'should not affect any other channel name lists' do
+        @nicks = %w[bunch of people]
+        channel_names = { '#otherchan' => %w[some people], @message.channel => (@nicks + [@message.nick]) }
+        @bot.instance_variable_set('@channel_names', channel_names.dup)
+        @listener.call(@message)
+        @bot.channel_names.should == { '#otherchan' => %w[some people], @message.channel => @nicks }
+      end
+      
+      it 'should handle the channel names not already tracking the channel' do
+        @bot.instance_variable_set('@channel_names', {})
+        @listener.call(@message)
+        @bot.channel_names[@message.channel].should == []
+      end
+      
+      it 'should handle the nick not appearing on the list' do
+        @nicks = %w[bunch of people]
+        @bot.instance_variable_set('@channel_names', { @message.channel => @nicks.dup })
+        
+        @listener.call(@message)
+        @bot.channel_names[@message.channel].should == @nicks
+      end
+
+      describe 'and the parter is the bot' do
+        before :each do
+          @message.nick = @bot.nick
+        end
+        
+        it 'should completely remove the channel from the names hash' do
+          channel_names = { '#otherchan' => %w[some people], @message.channel => %w[bunch of people] }
+          @bot.instance_variable_set('@channel_names', channel_names.dup)
+          @listener.call(@message)
+          @bot.channel_names.should == { '#otherchan' => %w[some people] }
+        end
+      end
+    end
+    
+    it 'should provide a quit listener' do
+      @bot.listeners[:quit].should_not be_nil
+    end
+    
+    describe 'quit listener' do
+      before :each do
+        @listener = @bot.listeners[:quit].first
+        @message = Struct.new(:nick).new('someguy')
+        @channel = '#somechan'
+        @nicks = %w[bunch of people]
+        @other_chan = '#otherchan'
+        @other_nicks = %w[other people here]
+      end
+      
+      it 'should be callable' do
+        @listener.should respond_to(:call)
+      end
+      
+      it "should remove the quitter's nick from every channel name list" do
+        @bot.instance_variable_set('@channel_names', { @channel => (@nicks + [@message.nick]), @other_chan => (@other_nicks + [@message.nick]) })
+        
+        @listener.call(@message)
+        @bot.channel_names.should == { @channel => @nicks, @other_chan => @other_nicks }
+      end
+      
+      it "should remove the quitter's nick from every channel name list no matter where or how many times it occurs" do
+        @bot.instance_variable_set('@channel_names', { @channel => @nicks.join(" #{@message.nick} ").split, @other_chan => @other_nicks.join(" #{@message.nick} ").split })
+        
+        @listener.call(@message)
+        @bot.channel_names.should == { @channel => @nicks, @other_chan => @other_nicks }
+      end
+      
+      it 'should not affect any other channel name lists' do
+        @bot.instance_variable_set('@channel_names', { @channel => (@nicks + [@message.nick]), @other_chan => @other_nicks.dup })
+        
+        @listener.call(@message)
+        @bot.channel_names.should == { @channel => @nicks, @other_chan => @other_nicks }
+      end
+    end
+    
+    it 'should provide a kill listener' do
+      @bot.listeners[:kill].should_not be_nil
+    end
+    
+    describe 'kill listener' do
+      before :each do
+        @listener = @bot.listeners[:kill].first
+        @message = Struct.new(:nick).new('someguy')
+        @channel = '#somechan'
+        @nicks = %w[bunch of people]
+        @other_chan = '#otherchan'
+        @other_nicks = %w[other people here]
+      end
+      
+      it 'should be callable' do
+        @listener.should respond_to(:call)
+      end
+      
+      it 'should remove the killed nick from every channel name list' do
+        @bot.instance_variable_set('@channel_names', { @channel => (@nicks + [@message.nick]), @other_chan => (@other_nicks + [@message.nick]) })
+        
+        @listener.call(@message)
+        @bot.channel_names.should == { @channel => @nicks, @other_chan => @other_nicks }
+      end
+      
+      it 'should remove the killed nick from every channel name list no matter where or how many times it occurs' do
+        @bot.instance_variable_set('@channel_names', { @channel => @nicks.join(" #{@message.nick} ").split, @other_chan => @other_nicks.join(" #{@message.nick} ").split })
+        
+        @listener.call(@message)
+        @bot.channel_names.should == { @channel => @nicks, @other_chan => @other_nicks }
+      end
+      
+      it 'should not affect any other channel name lists' do
+        @bot.instance_variable_set('@channel_names', { @channel => (@nicks + [@message.nick]), @other_chan => @other_nicks.dup })
+        
+        @listener.call(@message)
+        @bot.channel_names.should == { @channel => @nicks, @other_chan => @other_nicks }
+      end
+    end
+    
+    it 'should provide a nick listener' do
+      @bot.listeners[:nick].should_not be_nil
+    end
+    
+    describe 'nick listener' do
+      before :each do
+        @listener = @bot.listeners[:nick].first
+        @message = Struct.new(:nick, :recipient).new('someguy', 'someotherguy')
+        @channel = '#somechan'
+        @nicks = %w[bunch of people]
+        @other_chan = '#otherchan'
+        @other_nicks = %w[other people here]
+      end
+      
+      it 'should be callable' do
+        @listener.should respond_to(:call)
+      end
+      
+      it 'should replace the changed nick in every channel name list' do
+        @bot.instance_variable_set('@channel_names', { @channel => (@nicks + [@message.nick]), @other_chan => (@other_nicks + [@message.nick]) })
+        
+        @listener.call(@message)
+        @bot.channel_names.should == { @channel => (@nicks + [@message.recipient]), @other_chan => (@other_nicks + [@message.recipient]) }
+      end
+      
+      it 'should replace the the changed nick in every channel name list no matter where or how many times it occurs' do
+        @bot.instance_variable_set('@channel_names', { @channel => @nicks.join(" #{@message.nick} ").split, @other_chan => @other_nicks.join(" #{@message.nick} ").split })
+        
+        @listener.call(@message)
+        @bot.channel_names.should == { @channel => (@nicks + [@message.recipient]), @other_chan => (@other_nicks + [@message.recipient]) }
+      end
+    
+      it 'should not affect any other channel name lists' do
+        @bot.instance_variable_set('@channel_names', { @channel => (@nicks + [@message.nick]), @other_chan => @other_nicks.dup })
+        
+        @listener.call(@message)
+        @bot.channel_names.should == { @channel => (@nicks + [@message.recipient]), @other_chan => @other_nicks }
+      end
+    end
+    
+    it 'should not interfere with other bots' do
+      @bot_one = Cinch::Base.new
+      @bot_two = Cinch::Base.new
+      
+      @bot_one.track_names
+      @bot_two.track_names
+      
+      @message = Struct.new(:nick, :channel)
+      @message_one = @message.new('someguy', '#somechan')
+      @message_two = @message.new('otherguy', '#otherchan')
+      
+      @bot_one.listeners[:join].first.call(@message_one)
+      @bot_two.listeners[:join].first.call(@message_two)
+      
+      @bot_one.channel_names.should == { @message_one.channel => [@message_one.nick] }
+      @bot_two.channel_names.should == { @message_two.channel => [@message_two.nick] }
+    end
+    
+    it 'should not re-add listeners when asked to track names again' do
+      @bot.track_names
+      @bot.listeners[:join].length.should == 1
+    end
+    
+    it 'should not reset the channel name list when asked to track names again' do
+      @message = Struct.new(:nick, :channel).new('someguy', '#somechan')
+      @bot.listeners[:join].first.call(@message)
+      
+      @bot.track_names
+      @bot.channel_names.should == { @message.channel => [@message.nick] }
+    end
+  end
+  
+  describe 'before tracking names' do
+    it 'should indicate it is not tracking names' do
+      @bot.tracking_names?.should == false
+    end
+    
+    it 'should have no channel name list' do
+      @bot.channel_names.should be_nil
+    end
+    
+    it 'should have no join listener' do
+      @bot.listeners[:join].should be_nil
+    end
+    
+    it 'should have no names listener' do
+      @bot.listeners[:'353'].should be_nil
+    end
+    
+    it 'should have no part listener' do
+      @bot.listeners[:part].should be_nil
+    end
+    
+    it 'should have no quit listener' do
+      @bot.listeners[:quit].should be_nil
+    end
+    
+    it 'should have no kill listener' do
+      @bot.listeners[:kill].should be_nil
+    end
+    
+    it 'should have no nick listener' do
+      @bot.listeners[:nick].should be_nil
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cinch
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 3
-  - 2
-  version: 0.3.2
+  - 5
+  version: 0.3.5
 platform: ruby
 authors: 
 - Lee 'injekt' Jarvis
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-08 00:00:00 +01:00
+date: 2010-07-25 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,6 +45,7 @@ extra_rdoc_files:
 files: 
 - README.rdoc
 - Rakefile
+- spec/names_spec.rb
 - spec/irc/message_spec.rb
 - spec/irc/parser_spec.rb
 - spec/irc/socket_spec.rb
@@ -55,6 +56,7 @@ files:
 - spec/base_spec.rb
 - spec/helper.rb
 - lib/cinch.rb
+- lib/cinch/names.rb
 - lib/cinch/irc/socket.rb
 - lib/cinch/irc/message.rb
 - lib/cinch/irc/parser.rb