cinch 1.0.2 → 1.1.0

data/lib/cinch/cache_manager.rb

@@ -0,0 +1,15 @@
+module Cinch
+  class CacheManager
+    include Enumerable
+
+    def initialize(bot)
+      @bot = bot
+      @cache = {}
+      @mutex = Mutex.new
+    end
+
+    def each(&block)
+      @cache.each_value(&block)
+    end
+  end
+end

data/lib/cinch/callback.rb

@@ -3,9 +3,15 @@ module Cinch
   class Callback
     include Helpers
 
+    # @return [Bot]
     attr_reader :bot
     def initialize(bot)
       @bot = bot
     end
+
+    # (see Bot#synchronize)
+    def synchronize(*args, &block)
+      @bot.synchronize(*args, &block)
+    end
   end
 end

data/lib/cinch/channel.rb

@@ -13,22 +13,39 @@ module Cinch
       # @param [Bot] bot a bot
       # @return [Channel]
       # @see Bot#Channel
+      # @deprecated See {Bot#channel_manager} and {ChannelManager#find_ensured} instead
+      # @note This method does not work properly if running more than one bot
+      # @note This method will be removed in Cinch 2.0.0
       def find_ensured(name, bot)
+        $stderr.puts "Deprecation warning: Beginning with version 1.1.0, Channel.find_ensured should not be used anymore."
+        puts caller
+
         downcased_name = name.irc_downcase(bot.irc.isupport["CASEMAPPING"])
-        @channels[downcased_name] ||= new(name, bot)
-        @channels[downcased_name]
+        @channels[downcased_name] ||= bot.channel_manager.find_ensured(name)
       end
 
       # Finds a channel.
       #
       # @param [String] name name of a channel
       # @return [Channel, nil]
+      # @deprecated See {Bot#channel_manager} and {ChannelManager#find} instead
+      # @note This method does not work properly if running more than one bot
+      # @note This method will be removed in Cinch 2.0.0
       def find(name)
+        $stderr.puts "Deprecation warning: Beginning with version 1.1.0, Channel.find should not be used anymore."
+        puts caller
+
         @channels[name]
       end
 
       # @return [Array<Channel>] Returns all channels
+      # @deprecated See {Bot#channel_manager} and {CacheManager#each} instead
+      # @note This method does not work properly if running more than one bot
+      # @note This method will be removed in Cinch 2.0.0
       def all
+        $stderr.puts "Deprecation warning: Beginning with version 1.1.0, User.all should not be used anymore."
+        puts caller
+
         @channels.values
       end
     end
@@ -36,28 +53,28 @@ module Cinch
     # @return [Bot]
     attr_reader :bot
 
-    # @return [String]
+    # @return [String] the channel's name
     attr_reader :name
 
-    # @return [Array<User>]
+    # @return [Array<User>] all users in the channel
     attr_reader :users
     synced_attr_reader :users
 
-    # @return [String]
+    # @return [String] the channel's topic
     attr_accessor :topic
     synced_attr_reader :topic
 
-    # @return [Array<Ban>]
+    # @return [Array<Ban>] all active bans
     attr_reader :bans
     synced_attr_reader :bans
 
-    # @return [Array<String>]
+    # @return [Hash<String => Object>]
     attr_reader :modes
     synced_attr_reader :modes
     def initialize(name, bot)
       @bot   = bot
       @name  = name
-      @users = {}
+      @users = Hash.new {|h,k| h[k] = []}
       @bans  = []
 
       @modes = {}
@@ -85,8 +102,40 @@ module Cinch
       }
     end
 
+    # @group Checks
+
+    # @param [User, String] user An {User}-object or a nickname
+    # @return [Boolean] Check if a user is in the channel
+    def has_user?(user)
+      @users.has_key?(User(user))
+    end
+
+
+    # @return [Boolean] true if `user` is opped in the channel
+    def opped?(user)
+      user = @bot.user_manager.find_ensured(user) unless user.is_a?(User)
+      @users[user].include? "o"
+    end
+
+    # @return [Boolean] true if `user` is half-opped in the channel
+    def half_opped?(user)
+      user = @bot.user_manager.find_ensured(user) unless user.is_a?(User)
+      @users[user].include? "h"
+    end
+
+    # @return [Boolean] true if `user` is voiced in the channel
+    def voiced?(user)
+      user = @bot.user_manager.find_ensured(user) unless user.is_a?(User)
+      @users[user].include? "v"
+    end
+
+    # @endgroup
+
+    # @return [Number] The maximum number of allowed users in the
+    #   channel. 0 if unlimited.
     attr_accessor :limit
-    # @return [Number]
+    undef_method "limit"
+    undef_method "limit="
     def limit
       @modes["l"].to_i
     end
@@ -151,7 +200,7 @@ module Cinch
       end
     end
 
-    # @return [String, nil]
+    # @return [String, nil] The channel's key (aka password)
     attr_accessor :key
     undef_method "key"
     undef_method "key="
@@ -167,17 +216,6 @@ module Cinch
       end
     end
 
-    # Sets or unsets modes. Most of the time you won't need this but
-    # use setter methods like {Channel#invite_only=}.
-    #
-    # @param [String] s a mode string
-    # @return [void]
-    # @example
-    #   channel.mode "+n"
-    def mode(s)
-      @bot.raw "MODE #@name #{s}"
-    end
-
     # @api private
     # @return [void]
     def sync_modes(all = true)
@@ -189,17 +227,7 @@ module Cinch
       @bot.raw "MODE #@name"
     end
 
-    # @return [Boolean] true if `user` is opped in the channel
-    def opped?(user)
-      user = User.find_ensured(user, @bot) unless user.is_a?(User)
-      @users[user] == "@"
-    end
-
-    # @return [Boolean] true if `user` is voiced in the channel
-    def voiced?(user)
-      user = User.find_ensured(user, @bot) unless user.is_a?(User)
-      @users[user] == "+"
-    end
+    # @group Channel Manipulation
 
     # Bans someone from the channel.
     #
@@ -247,11 +275,78 @@ module Cinch
       @bot.raw "MODE #@name -v #{user}"
     end
 
+    # Invites a user to the channel.
+    #
+    # @param [String, User] user the user to invite
+    # @return [void]
+    def invite(user)
+      @bot.raw("INVITE #{user} #@name")
+    end
+
+    # Sets the topic.
+    #
+    # @param [String] new_topic the new topic
+    # @raise [Exceptions::TopicTooLong]
+    def topic=(new_topic)
+      if new_topic.size > @bot.irc.isupport["TOPICLEN"] && @bot.strict?
+        raise Exceptions::TopicTooLong, new_topic
+      end
+
+      @bot.raw "TOPIC #@name :#{new_topic}"
+    end
+
+    # Kicks a user from the channel.
+    #
+    # @param [String, User] user the user to kick
+    # @param [String] a reason for the kick
+    # @raise [Exceptions::KickReasonTooLong]
+    # @return [void]
+    def kick(user, reason = nil)
+      if reason.to_s.size > @bot.irc.isupport["KICKLEN"] && @bot.strict?
+        raise Exceptions::KickReasonTooLong, reason
+      end
+
+      @bot.raw("KICK #@name #{user} :#{reason}")
+    end
+
+    # Sets or unsets modes. Most of the time you won't need this but
+    # use setter methods like {Channel#invite_only=}.
+    #
+    # @param [String] s a mode string
+    # @return [void]
+    # @example
+    #   channel.mode "+n"
+    def mode(s)
+      @bot.raw "MODE #@name #{s}"
+    end
+
+    # Causes the bot to part from the channel.
+    #
+    # @param [String] message the part message.
+    # @return [void]
+    def part(message = nil)
+      @bot.raw "PART #@name :#{message}"
+    end
+
+    # Joins the channel
+    #
+    # @param [String] key the channel key, if any. If none is
+    #   specified but @key is set, @key will be used
+    # @return [void]
+    def join(key = nil)
+      if key.nil? and self.key != true
+        key = self.key
+      end
+      @bot.raw "JOIN #{[@name, key].compact.join(" ")}"
+    end
+
+    # @endgroup
+
     # @api private
     # @return [void]
-    def add_user(user, mode = nil)
+    def add_user(user, modes = [])
       @in_channel = true if user == @bot
-      @users[user] = mode # TODO can a user have more than one mode?
+      @users[user] = modes
     end
 
     # @api private
@@ -269,6 +364,8 @@ module Cinch
       @users.clear
     end
 
+    # @group Sending messages
+
     # Send a message to the channel.
     #
     # @param [String] message the message
@@ -280,6 +377,24 @@ module Cinch
     alias_method :privmsg, :send
     alias_method :msg, :send
 
+    # Send a notice to the channel.
+    #
+    # @param [String] message the message
+    # @return [void]
+    def notice(message)
+      @bot.notice(@name, message)
+    end
+
+    # Like {#safe_send} but for notices.
+    #
+    # @param (see #safe_send)
+    # @return (see #safe_send)
+    # @see #safe_send
+    # @todo (see #safe_send)
+    def safe_notice(message)
+      @bot.safe_notice(@name, message)
+    end
+
     # Send a message to the channel, but remove any non-printable
     # characters. The purpose of this method is to send text from
     # untrusted sources, like other users or feeds.
@@ -331,68 +446,7 @@ module Cinch
       @bot.safe_action(@name, message)
     end
 
-
-    # Invites a user to the channel.
-    #
-    # @param [String, User] user the user to invite
-    # @return [void]
-    def invite(user)
-      @bot.raw("INVITE #{user} #@name")
-    end
-
-    # Sets the topic.
-    #
-    # @param [String] new_topic the new topic
-    # @raise [Exceptions::TopicTooLong]
-    def topic=(new_topic)
-      if new_topic.size > @bot.irc.isupport["TOPICLEN"] && @bot.strict?
-        raise Exceptions::TopicTooLong, new_topic
-      end
-
-      @bot.raw "TOPIC #@name :#{new_topic}"
-    end
-
-    # Kicks a user from the channel.
-    #
-    # @param [String, User] user the user to kick
-    # @param [String] a reason for the kick
-    # @raise [Exceptions::KickReasonTooLong]
-    # @return [void]
-    def kick(user, reason = nil)
-      if reason.to_s.size > @bot.irc.isupport["KICKLEN"] && @bot.strict?
-        raise Exceptions::KickReasonTooLong, reason
-      end
-
-      @bot.raw("KICK #@name #{user} :#{reason}")
-    end
-
-    # Invites a user to the channel.
-    #
-    # @param [String, User] user the user to invite
-    # @return [void]
-    def invite(user)
-      @bot.raw "INVITE #{user} #@name"
-    end
-
-    # Causes the bot to part from the channel.
-    #
-    # @param [String] message the part message.
-    # @return [void]
-    def part(message = nil)
-      @bot.raw "PART #@name :#{message}"
-    end
-
-    # Joins the channel
-    #
-    # @param [String] key the channel key, if any. If none is
-    #   specified but @key is set, @key will be used
-    # @return [void]
-    def join(key = nil)
-      if key.nil? and self.key != true
-        key = self.key
-      end
-      @bot.raw "JOIN #{[@name, key].compact.join(" ")}"
-    end
+    # @endgroup
 
     # @return [Boolean]
     def ==(other)

data/lib/cinch/channel_manager.rb

@@ -0,0 +1,26 @@
+require "cinch/cache_manager"
+
+module Cinch
+  class ChannelManager < CacheManager
+    # Finds or creates a channel.
+    #
+    # @param [String] name name of a channel
+    # @return [Channel]
+    # @see Bot#Channel
+    def find_ensured(name)
+      downcased_name = name.irc_downcase(@bot.irc.isupport["CASEMAPPING"])
+      @mutex.synchronize do
+        @cache[downcased_name] ||= Channel.new(name, @bot)
+      end
+    end
+
+    # Finds a channel.
+    #
+    # @param [String] name name of a channel
+    # @return [Channel, nil]
+    def find(name)
+      downcased_name = name.irc_downcase(@bot.irc.isupport["CASEMAPPING"])
+      @cache[downcased_name]
+    end
+  end
+end

data/lib/cinch/constants.rb

@@ -38,7 +38,7 @@ module Cinch
   # 412 - 414 are returned by PRIVMSG to indicate that the message
   # wasn't delivered for some reason. ERR_NOTOPLEVEL and
   # ERR_WILDTOPLEVEL are errors that are returned when an invalid use of
-  # "PRIVMSG $<server>" or "PRIVMSG #<host>" is attempted.
+  # "PRIVMSG $&lt;server&gt;" or "PRIVMSG #&lt;host&gt;" is attempted.
   ERR_WILDTOPLEVEL = 414
 
   # Returned to a registered client to indicate that the command sent is
@@ -229,8 +229,10 @@ module Cinch
   # Reply by the server showing its version details. The &lt;version&gt;
   # is the version of the software being used (including any patchlevel
   # revisions) and the &lt;debuglevel&gt; is used to indicate if the
-  # server is running in "debug mode".<BR> The "comments" field may
-  # contain any comments about the version or further version details.
+  # server is running in "debug mode".
+  #
+  #The "comments" field may contain any comments about the version or
+  # further version details.
   RPL_VERSION  = 351
   RPL_WHOREPLY = 352
 
@@ -238,7 +240,7 @@ module Cinch
   # message. The RPL_WHOREPLY is only sent if there is an appropriate
   # match to the WHO query. If there is a list of parameters supplied
   # with a WHO message, a RPL_ENDOFWHO must be sent after processing
-  # each list item with <name> being the item.
+  # each list item with &lt;name&gt; being the item.
   RPL_ENDOFWHO  = 315
   RPL_NAMREPLY  = 353
   RPL_NAMEREPLY = RPL_NAMREPLY

data/lib/cinch/exceptions.rb

@@ -21,5 +21,14 @@ module Cinch
 
     class UnsupportedFeature < Generic
     end
+
+    class UnsupportedMode < Generic
+      def initialize(mode)
+        super "Cinch does not support the mode #{mode} yet."
+      end
+    end
+
+    class InvalidModeString < Generic
+    end
   end
 end