stuff/loc.rb trunk/examples/irbbot.rb trunk/examples/irccat.rb @@ -1,7 +1,9 @@ GUIDE - DONT: - send_command - subscribe_for_reply + ------ + | send_command + | subscribe_for_reply + ----------- -> the reply might come before your subscription is done and you miss it - DO: a) @@ -14,4 +16,5 @@ GUIDE CAVEATS -If you use send_quit directly instead of quit, the on_disconnect will receive a :disconnect - instead of a :quit. \ No newline at end of file + instead of a :quit. + stuff/guide.txt @@ -42,7 +42,7 @@ client = IRC::Connection.new do # and either FIXME. on_disconnect { |connection, reason| puts "Disconnected due to #{reason}" - IRC::Client::DefaultProc::OnDisconnect.call(client, connection, reason) + IRC::Connection::OnDisconnect.call(client, connection, reason) } end trunk/examples/connection_dsl_evented.rb @@ -144,7 +144,13 @@ module SilverPlatter end def inspect # :nodoc: - "#<%s:0x%x %s %s (%d users)" % [self.class, object_id, @name, @connection, size] + sprintf "#<%s:0x%x %s %s (%d users)" + self.class, + object_id<<1, + @name, + @connection, + size + # /sprintf end # Channels can't be duped trunk/lib/silverplatter/irc/channel.rb @@ -219,7 +219,12 @@ module SilverPlatter end def inspect # :nodoc: - "#<%s:0x%x connection=%08x (%d channels)>" % [self.class, object_id>>1, @connection.object_id>>1, size] + sprintf "#<%s:0x%x connection=%08x (%d channels)>", + self.class, + object_id<<1, + @connection.object_id<<1, + size + # /sprintf end private trunk/lib/silverplatter/irc/channellist.rb @@ -31,6 +31,9 @@ module SilverPlatter # * SilverPlatter::IRC::Connection # * SilverPlatter::IRC::Channel # * http://www.faqs.org/rfcs/rfc1459.html Section 4.2.3.1 + # + # == TODO + # Change implementation to use a String instead of a Hash. class ChannelModes include RFC1459_ChannelModes @@ -112,6 +115,6 @@ module SilverPlatter def __hash__ @modes end - end - end -end + end # ChannelModes + end # IRC +end # SilverPlatter trunk/lib/silverplatter/irc/channelmodes.rb @@ -8,6 +8,8 @@ require 'silverplatter/irc/color/sequence' + + module SilverPlatter module IRC @@ -36,170 +38,261 @@ module SilverPlatter # * SilverPlatter::IRC::Color::Sequence # * SilverPlatter::IRC::Color::String module Color + # The code to reset formatting Reset = 3.chr.freeze + + # The code to switch bold on Bold = 2.chr.freeze + + # The code to switch plain on Plain = 15.chr.freeze + + # The code to switch reversing on Reverse = 18.chr.freeze + + # The code to switch underline on Underline = 31.chr.freeze + + # The code to switch italic on Italic = 29.chr.freeze + + # The code to switch blinking on Blink = 9.chr.freeze # ? + + + # Foreground color with the given code. Code is 0-15. + # The codes translate to: + # * 0: white + # * 1: black + # * 2: blue + # * 3: green + # * 4: red + # * 5: brown + # * 6: purple + # * 7: orange + # * 8: yellow + # * 9: light green + # * 10: teal + # * 11: light cyan + # * 12: light blue + # * 13: pink + # * 14: grey + # * 15: light grey + # For every color code there's a named method too. def color(code) Sequence.new(code) end + # Background color with the given code. Code is 0-15. + # The codes translate to: + # * 0: white + # * 1: black + # * 2: blue + # * 3: green + # * 4: red + # * 5: brown + # * 6: purple + # * 7: orange + # * 8: yellow + # * 9: light green + # * 10: teal + # * 11: light cyan + # * 12: light blue + # * 13: pink + # * 14: grey + # * 15: light grey + # For every color code there's a named method too. def on_color(code) Sequence.new(nil, code) end + # Set coloring back to plain def plain Sequence.new(nil, nil, Plain) end + # Set the font to bold def bold Sequence.new(nil, nil, Bold) end + # Set the text to be reversed def reverse Sequence.new(nil, nil, Reverse) end + # Set the font to be underlined def underline Sequence.new(nil, nil, Underline) end + # Set the font to italic def italic Sequence.new(nil, nil, Italic) end + # Set the text to blink def blink Sequence.new(nil, nil, Blink) end + # White foreground color def white Sequence.new(0) end + # Black foreground color def black Sequence.new(1) end + # Blue foreground color def blue Sequence.new(2) end + # Green foreground color def green Sequence.new(3) end + # Red foreground color def red Sequence.new(4) end + # Brown foreground color def brown Sequence.new(5) end + # Purple foreground color def purple Sequence.new(6) end + # Orange foreground color def orange Sequence.new(7) end + # Yellow foreground color def yellow Sequence.new(8) end + # Light green foreground color def ltgreen Sequence.new(9) end + # Teal foreground color def teal Sequence.new(10) end + # Light cyan foreground color def ltcyan Sequence.new(11) end + # Light blue foreground color def ltblue Sequence.new(12) end + # Pink foreground color def pink Sequence.new(13) end + # Grey foreground color def grey Sequence.new(14) end + # Light grey foreground color def ltgrey Sequence.new(15) end + # White background color def on_white Sequence.new(nil, 0) end + # Black background color def on_black Sequence.new(nil, 1) end + # Blue background color def on_blue Sequence.new(nil, 2) end + # Green background color def on_green Sequence.new(nil, 3) end + # Red background color def on_red Sequence.new(nil, 4) end + # Brown background color def on_brown Sequence.new(nil, 5) end + # Purple background color def on_purple Sequence.new(nil, 6) end + # Orange background color def on_orange Sequence.new(nil, 7) end + # Yellow background color def on_yellow Sequence.new(nil, 8) end + # Light green background color def on_ltgreen Sequence.new(nil, 9) end + # Teal background color def on_teal Sequence.new(nil, 10) end + # Light cyan background color def on_ltcyan Sequence.new(nil, 11) end + # Light blue background color def on_ltblue Sequence.new(nil, 12) end + # Pink background color def on_pink Sequence.new(nil, 13) end + # Grey background color def on_grey Sequence.new(nil, 14) end + # Light grey background color def on_ltgrey Sequence.new(nil, 15) end trunk/lib/silverplatter/irc/color.rb @@ -206,14 +206,14 @@ module SilverPlatter def inspect #:nodoc: fields = @data.select { |k,v| v }.map { |k,v| "#{k}=#{v}" }.sort.join(", ") comma = fields.empty? ? "" : ", " - "#<%s:0x%x %s %s%s%s>" % [ + sprintf "#<%s:0x%x %s %s%s%s>", self.class, object_id<<1, @raw.inspect, inspect_fields, comma, fields - ] + # /sprintf end def method_missing(m, *args, &block) # :nodoc: trunk/lib/silverplatter/irc/message.rb @@ -208,7 +208,11 @@ module SilverPlatter end def inspect # :nodoc: - "#<%s:0x%x %s>" % [self.class, object_id, @command_sets.join(', ')] + sprintf "#<%s:0x%x %s>" + self.class, + object_id<<1, + @command_sets.join(', ') + # /sprintf end # parses an incomming message and returns a Message object from which you @@ -216,7 +220,7 @@ module SilverPlatter # Expects the newlines to be already chomped off. # Process a message and set the additional fields # process can have side-effects on the associated Connection - # FIXME fix documentation of this method + # FIXME: documentation of this method def server_message(raw) prefix, command, params, symbol, from = nil from, recipient, channel, text, identified = nil trunk/lib/silverplatter/irc/parser.rb @@ -14,11 +14,8 @@ module SilverPlatter module IRC class Parser - # == Indexing - # * Author: Stefan Rusterholz - # * Contact: apeiros@gmx.net> - # * Revision: $Revision$ - # * Date: $Date$ + # == Authors + # * Stefan Rusterholz <apeiros@gmx.net> # # == About # Provides parsing information about specific commands. @@ -32,8 +29,8 @@ module SilverPlatter # * regex: The regular expression for the parameter part of the message # * mapping: The fields associated with the regex' captures # * processor: A proc to process the message further, possibly having side-effects - # See Butler::IRC::COMMANDS for samples on instanciation of - # Butler::IRC::Command objects. + # See SilverPlatter::IRC::COMMANDS for samples on instanciation of + # SilverPlatter::IRC::Command objects. # # == Notes # trunk/lib/silverplatter/irc/parser/command.rb @@ -58,7 +58,7 @@ add("mode", :MODE, /^(\S*) (.*)/, [:recipient, :arguments]) { |connection, } add("nick", :NICK, /^:?(.*)/, [:nick]) { |connection, message, fields| message[:old_nick] = message.from.nick - connection.update_user(from, message.nick) if message.from + connection.update_user(message.from, message.nick) if message.from } add("notice", :NOTICE, /(\S+) :(.*)/, [:recipient, :text]) { |connection, message, fields| if connection.msg_identify then trunk/lib/silverplatter/irc/parser/rfc2812/commands.rb @@ -15,6 +15,7 @@ require 'thread' module SilverPlatter module IRC + # Used by Connection#prepare class Preparation # :nodoc: def initialize(connection, block) trunk/lib/silverplatter/irc/preparation.rb @@ -130,6 +130,7 @@ module SilverPlatter raise ArgumentError, "Unknown arguments: #{options.keys.inspect}" unless options.empty? end + # Whether this Socket is currently connected to a server or not. def connected? @connected end @@ -231,13 +232,13 @@ module SilverPlatter end # identify nickname to nickserv - # FIXME, figure out what the server supports, possibly requires it - # to be moved to Butler::IRC::Client (to allow ghosting, nickchange, identify) + # FIXME: figure out what the server supports, possibly requires it + # to be moved to SilverPlatter::IRC::Connection (to allow ghosting, nickchange, identify) def send_identify(password) write_with_eol("NS :IDENTIFY #{password}") end - # FIXME, figure out what the server supports, possibly requires it + # FIXME: figure out what the server supports, possibly requires it # to be moved to SilverPlatter::IRC::Connection (to allow ghosting, nickchange, identify) def send_ghost(nickname, password) write_with_eol("NS :GHOST #{nickname} #{password}") @@ -353,6 +354,7 @@ module SilverPlatter # Give Op to user in channel # User can be a nick or IRC::User, either one or an array. + # FIXME: check number of targets MODE can take def send_multiple_mode(channel, pre, flag, targets) (0...targets.length).step(10) { |i| slice = targets[i,10] @@ -423,15 +425,15 @@ module SilverPlatter end def inspect # :nodoc: - "#<%s:0x%08x %s:%s from %s using '%s', stats: %s>" % [ + sprintf "#<%s:0x%08x %s:%s from %s using '%s', stats: %s>", self.class, - object_id << 1, + object_id<<1, @server, @port, @host || "<default>", @eol.inspect[1..-2], @count.inspect - ] + # /sprintf end end end trunk/lib/silverplatter/irc/socket.rb @@ -8,6 +8,7 @@ module SilverPlatter module IRC + # This module is included in the String-class and provides some methods helping with irc # related issues. module StringHelpers trunk/lib/silverplatter/irc/string.rb @@ -27,12 +27,12 @@ module SilverPlatter # * http://www.faqs.org/rfcs/rfc1459.html Section 4.2.3.1 class Topic < Struct.new(:text, :set_by, :set_at) def inspect - "#<%s %s --%s on %s>" % [ + sprintf "#<%s %s --%s on %s>", self.class, text, set_by, set_at.strftime("%Y-%m-%d %H:%M") - ] + # /sprintf end end end trunk/lib/silverplatter/irc/topic.rb @@ -186,15 +186,15 @@ module SilverPlatter end def inspect # :nodoc: - "#<%s:0x%x %s!%s@%s (%s) in %s>" % [ + sprint "#<%s:0x%x %s!%s@%s (%s) in %s>", self.class, - object_id, + object_id<<1, @nick || "?", @user || "?", @host || "?", @real || "?", @channels.keys.map { |c| c.name } - ] + # /sprintf end # Users can't be duped @@ -263,23 +263,23 @@ module SilverPlatter # user.add_flag(@channels["#foo], "@") def add_flag(channel, flag) #:nodoc: raise ArgumentError, "User #{self} is not listed in #{channel}" unless @channels.has_key?(channel) - raise ArgumentError, "Invalid flag '#{flag}'" unless Flags.include?(flag) + #raise ArgumentError, "Invalid flag '#{flag}'" unless UserModes.include?(flag) current = @channels[channel] - @channels[channel] = (current+flag).split.sort.join unless current.include?(flag) + @channels[channel] = (current+flag).unpack("C*").uniq.sort.pack("C*") end # user.add_flags(@channels["#foo], "@+") def add_flags(channel, flags) #:nodoc: raise ArgumentError, "User #{self} is not listed in #{channel}" unless @channels.has_key?(channel) - #raise ArgumentError, "Invalid flag '#{flag}'" unless Flags.include?(flag) + #raise ArgumentError, "Invalid flag '#{flag}'" unless UserModes.include?(flag) current = @channels[channel] - @channels[channel] = (current+flags).split.uniq.sort.join + @channels[channel] = (current+flags).unpack("C*").uniq.sort.pack("C*") end # user.delete_flag(@channels["#foo], "@") def delete_flag(channel, flag) #:nodoc: raise ArgumentError, "User #{self} is not listed in #{channel}" unless @channels.has_key?(channel) - raise ArgumentError, "Invalid flag '#{flag}'" unless Flags.include?(flag) + #raise ArgumentError, "Invalid flag '#{flag}'" unless UserModes.include?(flag) @channels[channel] = @channels[channel].delete(flag) end trunk/lib/silverplatter/irc/user.rb @@ -34,7 +34,7 @@ module SilverPlatter # list.delete_nick(nickname) # delete a user from which you only know the nick # # == Description - # UserList is used to keep a list of user. It can be used standalone, but it is + # UserList is used to keep a list of users. It can be used standalone, but it is # supposed to be used in conjunction with an IRC::Connection which is used for # lookups by nick and for the appropriate casemapping. # UserList is Enumerable over all users, yielding user => value @@ -265,7 +265,12 @@ module SilverPlatter end def inspect # :nodoc: - "#<%s:0x%x %s connection: %08x (%d users)>" % [self.class, object_id>>1, @connection.object_id>>1, size] + sprintf "#<%s:0x%x %s connection: %08x (%d users)>" + self.class, + object_id<<1, + @connection.object_id>>1, + size + # /sprintf end private trunk/lib/silverplatter/irc/userlist.rb @@ -12,6 +12,7 @@ require 'rubygems/version' module SilverPlatter module IRC + # The version of SilverPlatter::IRC VERSION = Gem::Version.new("0.1.0") end end trunk/lib/silverplatter/irc/version.rb 94cf175ad7ef133c689be4ab7eb60bac3ddf836b Stefan Rusterholz apeiros@gmx.net http://github.com/apeiros/silverplatter-irc/commit/44988c9fd20a16e740884197883e251d40713820 44988c9fd20a16e740884197883e251d40713820 2008-06-19T03:37:09-07:00 2008-06-19T03:37:09-07:00 minor changes, added loc.rb and irccat.rb ada182d9385b3a106f6d7be6cc185e3f233662b3 Stefan Rusterholz apeiros@gmx.net