cinch 1.0.2 → 1.1.0

data/lib/cinch/rubyext/string.rb

@@ -2,9 +2,9 @@ class String
   def irc_downcase(mapping)
     case mapping
     when :rfc1459
-      self.tr("A-Z[]\\^", "a-z{}|~")
+      self.tr("A-Z[]\\\\^", "a-z{}|~")
     when :"strict-rfc1459"
-      self.tr("A-Z[]\\", "a-z{}|")
+      self.tr("A-Z[]\\\\", "a-z{}|")
     else
       # when :ascii or unknown/nil
       self.tr("A-Z", "a-z")
@@ -16,9 +16,9 @@ class String
     when :ascii
       self.tr("a-z", "A-Z")
     when :rfc1459
-      self.tr("a-z{}|~", "A-Z[]\\^")
+      self.tr("a-z{}|~", "A-Z[]\\\\^")
     when :strict-rfc1459
-      self.tr("a-z{}|", "A-Z[]\\")
+      self.tr("a-z{}|", "A-Z[]\\\\")
     end
   end
 end

data/lib/cinch/syncable.rb

@@ -3,6 +3,7 @@ module Cinch
     # Blocks until the object is synced.
     #
     # @return [void]
+    # @api private
     def wait_until_synced(attr)
       attr = attr.to_sym
       while true
@@ -22,14 +23,21 @@ module Cinch
       @synced_attributes << attribute
     end
 
+    # @return [Boolean]
+    # @api private
     def synced?(attribute)
       @synced_attributes.include?(attribute)
     end
 
+    # @return [void]
+    # @api private
     def unsync(attribute)
       @synced_attributes.delete(attribute)
     end
 
+    # @return [void]
+    # @api private
+    # @since 1.0.1
     def unsync_all
       @synced_attributes.clear
     end

data/lib/cinch/user.rb

@@ -3,7 +3,7 @@ module Cinch
   class User
     include Syncable
 
-    @users = {}
+    @users = {} # this will be removed with version 2.0.0
     class << self
 
       # @overload find_ensured(nick, bot)
@@ -21,35 +21,54 @@ module Cinch
       #   @param [Bot]    bot  An instance of bot
       #
       # @return [User]
+      # @deprecated See {Bot#user_manager} and {UserManager#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(*args)
-        # FIXME CASEMAPPING
+        $stderr.puts "Deprecation warning: Beginning with version 1.1.0, User.find_ensured should not be used anymore."
+        puts caller
+
         case args.size
         when 2
           nick = args.first
-          bargs = [args.first]
           bot  = args.last
+          bargs = [nick]
         when 4
           nick = args[1]
-          bot = args.pop
+          bot  = args.pop
           bargs = args
         else
           raise ArgumentError
         end
-        downcased_nick = nick.irc_downcase(bot.irc.isupport["CASEMAPPING"])
-        @users[downcased_nick] ||= new(*bargs, bot)
-        @users[downcased_nick]
+        downcased_nick = nick.irc_downcase(@bot.irc.isupport["CASEMAPPING"])
+        @users[downcased_nick] = args.last.user_manager.find_ensured(*args[0..-2])
+        # note: the complete case statement and the assignment to
+        #   @users is only for keeping compatibility with older
+        #   versions, which still use User.find and User.all.
       end
 
       # Finds a user.
       #
       # @param [String] nick nick of a user
       # @return [User, nil]
+      # @deprecated See {Bot#user_manager} and {UserManager#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(nick)
-        @users[nick]
+        $stderr.puts "Deprecation warning: Beginning with version 1.1.0, User.find should not be used anymore."
+        puts caller
+
+        @users[downcased_nick]
       end
 
       # @return [Array<User>] Returns all users
+      # @deprecated See {Bot#user_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
+
         @users.values
       end
     end
@@ -57,12 +76,16 @@ module Cinch
 
     # @return [String]
     attr_reader :nick
+    # @return [String]
+    attr_reader :last_nick
     # @return [Bot]
     attr_reader :bot
     # @return [Boolean]
     attr_reader :synced
     # @return [Boolean]
     attr_reader :in_whois
+    # @api private
+    attr_writer :in_whois
 
     # @return [String]
     attr_reader :user
@@ -115,12 +138,12 @@ module Cinch
     # By default, you can use methods like User#user, User#host and
     # alike – If you however fear that another thread might change
     # data while you're using it and if this means a critical issue to
-    # your code, you can store the result of this method and work with
-    # that instead.
+    # your code, you can store a clone of the result of this method
+    # and work with that instead.
     #
     # @example
-    #   on :channel do
-    #     data = user.data
+    #   on :channel do |m|
+    #     data = m.user.data.dup
     #     do_something_with(data.user)
     #     do_something_with(data.host)
     #   end
@@ -165,7 +188,7 @@ module Cinch
     #
     # @return [Boolean] true if the user is identified
     def authed?
-      @data[:authname]
+      !attr(:authname).nil?
     end
 
     # @see Syncable#attr
@@ -196,6 +219,7 @@ module Cinch
     #   an unknown user
     # @return [void]
     # @api private
+    # @since 1.0.1
     def end_of_whois(values, not_found = false)
       @in_whois = false
       if not_found
@@ -236,12 +260,17 @@ module Cinch
       @synced = true
     end
 
+    # @return [void]
+    # @since 1.0.1
     # @api private
+    # @see Syncable#unsync_all
     def unsync_all
       @synced = false
       super
     end
 
+    # @group Sending messages
+
     # Send a message to the user.
     #
     # @param [String] message the message
@@ -252,6 +281,24 @@ module Cinch
     alias_method :privmsg, :send
     alias_method :msg, :send
 
+    # Send a notice to the user.
+    #
+    # @param [String] message the message
+    # @return [void]
+    def notice(message)
+      @bot.notice(@nick, 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(@nick, message)
+    end
+
     # Send a message to the user, but remove any non-printable
     # characters. The purpose of this method is to send text from
     # untrusted sources, like other users or feeds.
@@ -303,6 +350,8 @@ module Cinch
       @bot.safe_action(@name, message)
     end
 
+    # @endgroup
+
     # @return [String]
     def to_s
       @nick
@@ -343,6 +392,12 @@ module Cinch
       Mask.new(s)
     end
 
+    # @api private
+    def update_nick(new_nick)
+      @last_nick, @nick = @nick, new_nick
+      @bot.user_manager.update_nick(self)
+    end
+
     # Provides synced access to user attributes.
     def method_missing(m, *args)
       if m.to_s =~ /^(.+)_unsynced$/

data/lib/cinch/user_manager.rb

@@ -0,0 +1,60 @@
+require "cinch/cache_manager"
+
+module Cinch
+  class UserManager < CacheManager
+    # Finds or creates a user.
+    # @overload find_ensured(nick)
+    #   Finds or creates a user based on his nick.
+    #
+    #   @param [String] nick The user's nickname
+    #   @return [User]
+    # @overload find_ensured(user, nick, host)
+    #   Finds or creates a user based on his nick but already
+    #   setting user and host.
+    #
+    #   @param [String] user The username
+    #   @param [String] nick The nickname
+    #   @param [String] host The user's hostname
+    #   @return [User]
+    # @return [User]
+    # @see Bot#User
+    def find_ensured(*args)
+      case args.size
+      when 1
+        nick = args.first
+        bargs = [nick]
+      when 3
+        nick = args[1]
+        bargs = args
+      else
+        raise ArgumentError
+      end
+      downcased_nick = nick.irc_downcase(@bot.irc.isupport["CASEMAPPING"])
+      @mutex.synchronize do
+        @cache[downcased_nick] ||= User.new(*bargs, @bot)
+      end
+    end
+
+    # Finds a user.
+    #
+    # @param [String] nick nick of a user
+    # @return [User, nil]
+    def find(nick)
+      downcased_nick = nick.irc_downcase(@bot.irc.isupport["CASEMAPPING"])
+      @cache[downcased_nick]
+    end
+
+    # @api private
+    def update_nick(user)
+      @mutex.synchronize do
+        @cache[user.nick.irc_downcase(@bot.irc.isupport["CASEMAPPING"])] = user
+        @cache.delete user.last_nick.irc_downcase(@bot.irc.isupport["CASEMAPPING"])
+      end
+    end
+
+    # @api private
+    def delete(user)
+      @cache.delete_if {|n, u| u == user }
+    end
+  end
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: cinch
 version: !ruby/object:Gem::Version 
-  hash: 19
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 2
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors: 
 - Lee Jarvis
@@ -16,25 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-02 00:00:00 +02:00
+date: 2011-01-16 00:00:00 +01:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 1
-        - 3
-        - 0
-        version: 1.3.0
-  type: :development
-  version_requirements: *id001
+dependencies: []
+
 description: A simple, friendly DSL for creating IRC bots
 email: 
 - lee@jarvis.co
@@ -47,19 +31,11 @@ extra_rdoc_files: []
 
 files: 
 - LICENSE
-- Rakefile
 - README.md
-- spec/user_spec.rb
-- spec/plugin_spec.rb
-- spec/spec_helper.rb
-- spec/bot_spec.rb
-- spec/spec.opts
-- spec/channel_spec.rb
-- spec/message_spec.rb
-- spec/cinch_spec.rb
-- spec/irc_spec.rb
 - lib/cinch/irc.rb
+- lib/cinch/channel_manager.rb
 - lib/cinch/mask.rb
+- lib/cinch/cache_manager.rb
 - lib/cinch/exceptions.rb
 - lib/cinch/rubyext/module.rb
 - lib/cinch/rubyext/queue.rb
@@ -71,24 +47,32 @@ files:
 - lib/cinch/user.rb
 - lib/cinch/constants.rb
 - lib/cinch/callback.rb
-- lib/cinch/PLANNED
 - lib/cinch/syncable.rb
+- lib/cinch/pattern.rb
 - lib/cinch/message_queue.rb
+- lib/cinch/mode_parser.rb
 - lib/cinch/helpers.rb
 - lib/cinch/ban.rb
 - lib/cinch/plugin.rb
+- lib/cinch/user_manager.rb
 - lib/cinch/isupport.rb
 - lib/cinch/logger/logger.rb
 - lib/cinch/logger/formatted_logger.rb
+- lib/cinch/logger/zcbot_logger.rb
 - lib/cinch/logger/null_logger.rb
 - lib/cinch.rb
 - examples/plugins/urban_dict.rb
 - examples/plugins/multiple_matches.rb
 - examples/plugins/autovoice.rb
 - examples/plugins/hello.rb
+- examples/plugins/lambdas.rb
+- examples/plugins/last_nick.rb
+- examples/plugins/hooks.rb
+- examples/plugins/timer.rb
 - examples/plugins/url_shorten.rb
 - examples/plugins/seen.rb
 - examples/plugins/join_part.rb
+- examples/plugins/own_events.rb
 - examples/plugins/google.rb
 - examples/plugins/memo.rb
 - examples/plugins/msg.rb
@@ -103,7 +87,7 @@ files:
 - examples/basic/memo.rb
 - examples/basic/msg.rb
 has_rdoc: true
-homepage: http://doc.injekt.net/cinch
+homepage: http://rubydoc.info/github/cinchrb/cinch
 licenses: []
 
 post_install_message: 
@@ -116,7 +100,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 49
       segments: 
       - 1
       - 9
@@ -127,7 +110,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"

data/Rakefile

@@ -1,66 +0,0 @@
-require 'rubygems'
-require 'rake'
-require 'rake/clean'
-
-$LOAD_PATH.unshift('lib') unless $LOAD_PATH.include?('lib')
-require 'cinch'
-
-CLEAN.include ["doc"]
-
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-require 'yard'
-YARD::Rake::YardocTask.new do |t|
-  t.files   = ['lib/**/*.rb', 'README.md']
-  t.options = [
-    '-m', 'markdown', 
-    '--hide-void-return',
-    '--quiet',
-    '--title', "Cinch #{Cinch::VERSION} Documentation",
-    '--main', 'README.md',
-  ] 
-end
-
-namespace :gem do
-  desc "Build gem"
-  task :build => ["rake:clean"] do
-    sh("gem build cinch.gemspec")
-  end
-
-  desc "Uninstall gem (not root)"
-  task :uninstall do
-    sh("gem uninstall cinch -v #{Cinch::VERSION}")
-  end
-
-  desc "Release to rubygems"
-  task :release => [:build] do
-    sh("gem push ./cinch-#{Cinch::VERSION}.gem")
-  end
-
-  desc "Install gem (not root)"
-  task :install => :build do
-    sh("gem install ./cinch-#{Cinch::VERSION} --local")
-  end
-end
-
-namespace :doc do
-  desc "Upload documentation"
-  task :push => [:yard] do
-    # XXX rename once merge is complete
-    sh("scp -r doc injekt:injekt.net/doc/cinch-merge")
-  end
-end
-
-task :version do
-  puts "Cinch version #{Cinch::VERSION}"
-end
-
-desc "Install gem (not root)"
-task :install => "gem:install"
-
-task :default => :spec
-