cinch 1.1.3 → 2.0.0.pre.1

data/lib/cinch/{user_manager.rb → user_list.rb}

@@ -1,7 +1,10 @@
-require "cinch/cache_manager"
+require "cinch/cached_list"
 
 module Cinch
-  class UserManager < CacheManager
+  # @since 2.0.0
+  # @version 1.1.0
+  # @note In prior versions, this class was called UserManager
+  class UserList < CachedList
     # Finds or creates a user.
     # @overload find_ensured(nick)
     #   Finds or creates a user based on his nick.
@@ -45,6 +48,7 @@ module Cinch
     end
 
     # @api private
+    # @return [void]
     def update_nick(user)
       @mutex.synchronize do
         @cache[user.nick.irc_downcase(@bot.irc.isupport["CASEMAPPING"])] = user
@@ -53,6 +57,7 @@ module Cinch
     end
 
     # @api private
+    # @return [void]
     def delete(user)
       @cache.delete_if {|n, u| u == user }
     end

data/lib/cinch/utilities/deprecation.rb

@@ -0,0 +1,12 @@
+module Cinch
+  # @since 2.0.0
+  # @api private
+  module Utilities
+    module Deprecation
+      def self.print_deprecation(version, method)
+        $stderr.puts "Deprecation warning: Beginning with version #{version}, #{method} should not be used anymore."
+        $stderr.puts caller
+      end
+    end
+  end
+end

data/lib/cinch/utilities/encoding.rb

@@ -0,0 +1,54 @@
+module Cinch
+  # @since 2.0.0
+  # @api private
+  module Utilities
+    module Encoding
+      def self.encode_incoming(string, encoding)
+        string = string.dup
+        if encoding == :irc
+          # If incoming text is valid UTF-8, it will be interpreted as
+          # such. If it fails validation, a CP1252 -> UTF-8 conversion
+          # is performed. This allows you to see non-ASCII from mIRC
+          # users (non-UTF-8) and other users sending you UTF-8.
+          #
+          # (from http://xchat.org/encoding/#hybrid)
+          string.force_encoding("UTF-8")
+          if !string.valid_encoding?
+            string.force_encoding("CP1252").encode!("UTF-8", {:invalid => :replace, :undef => :replace})
+          end
+        else
+          string.force_encoding(encoding).encode!({:invalid => :replace, :undef => :replace})
+          string = string.chars.select { |c| c.valid_encoding? }.join
+        end
+
+        return string
+      end
+
+      def self.encode_outgoing(string, encoding)
+        string = string.dup
+        if encoding == :irc
+          # If your text contains only characters that fit inside the CP1252
+          # code page (aka Windows Latin-1), the entire line will be sent
+          # that way. mIRC users should see it correctly. XChat users who
+          # are using UTF-8 will also see it correctly, because it will fail
+          # UTF-8 validation and will be assumed to be CP1252, even by older
+          # XChat versions.
+          #
+          # If the text doesn't fit inside the CP1252 code page, (for example if you
+          # type Eastern European characters, or Russian) it will be sent as UTF-8. Only
+          # UTF-8 capable clients will be able to see these characters correctly
+          #
+          # (from http://xchat.org/encoding/#hybrid)
+          begin
+            string.encode!("CP1252")
+          rescue ::Encoding::UndefinedConversionError
+          end
+        else
+          string.encode!(encoding, {:invalid => :replace, :undef => :replace}).force_encoding("ASCII-8BIT")
+        end
+
+        return string
+      end
+    end
+  end
+end

data/lib/cinch/utilities/kernel.rb

@@ -0,0 +1,13 @@
+module Cinch
+  # @since 2.0.0
+  # @api private
+  module Utilities
+    module Kernel
+      # @return [Object]
+      def self.string_to_const(s)
+        return s unless s.is_a?(::String)
+        s.split("::").inject(Kernel) {|base, name| base.const_get(name) }
+      end
+    end
+  end
+end

data/lib/cinch/utilities/string.rb

@@ -0,0 +1,13 @@
+module Cinch
+  # @since 2.0.0
+  # @api private
+  module Utilities
+    module String
+      # @return [String]
+      # @todo Handle mIRC color codes more gracefully.
+      def self.filter_string(string)
+        string.gsub(/[\x00-\x1f]/, '')
+      end
+    end
+  end
+end

data/lib/cinch/version.rb

@@ -0,0 +1,4 @@
+module Cinch
+  # Version of the library
+  VERSION = '2.0.0-pre.1'
+end

metadata

@@ -1,21 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: cinch
 version: !ruby/object:Gem::Version
-  version: 1.1.3
-  prerelease: 
+  version: 2.0.0.pre.1
+  prerelease: 6
 platform: ruby
 authors:
-- Lee Jarvis
 - Dominik Honnef
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-05-12 00:00:00.000000000 +02:00
-default_executable: 
+date: 2012-03-03 00:00:00.000000000 Z
 dependencies: []
 description: A simple, friendly DSL for creating IRC bots
 email:
-- lee@jarvis.co
 - dominikh@fork-bomb.org
 executables: []
 extensions: []
@@ -23,62 +20,105 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- lib/cinch.rb
-- lib/cinch/constants.rb
-- lib/cinch/cache_manager.rb
+- docs/changes.md
+- docs/readme.md
+- docs/bot_options.md
+- docs/common_mistakes.md
+- docs/events.md
+- docs/encodings.md
+- docs/logging.md
+- docs/common_tasks.md
+- docs/migrating.md
+- lib/cinch/formatting.rb
 - lib/cinch/channel.rb
-- lib/cinch/user_manager.rb
-- lib/cinch/message_queue.rb
+- lib/cinch/timer.rb
+- lib/cinch/sasl/diffie_hellman.rb
+- lib/cinch/sasl/plain.rb
+- lib/cinch/sasl/dh_blowfish.rb
+- lib/cinch/sasl/mechanism.rb
+- lib/cinch/network.rb
+- lib/cinch/sasl.rb
+- lib/cinch/cached_list.rb
 - lib/cinch/bot.rb
-- lib/cinch/irc.rb
-- lib/cinch/ban.rb
-- lib/cinch/syncable.rb
-- lib/cinch/message.rb
-- lib/cinch/channel_manager.rb
-- lib/cinch/logger/zcbot_logger.rb
-- lib/cinch/logger/null_logger.rb
-- lib/cinch/logger/formatted_logger.rb
-- lib/cinch/logger/logger.rb
+- lib/cinch/storage.rb
 - lib/cinch/isupport.rb
-- lib/cinch/pattern.rb
-- lib/cinch/user.rb
 - lib/cinch/helpers.rb
-- lib/cinch/callback.rb
+- lib/cinch/handler.rb
+- lib/cinch/handler_list.rb
 - lib/cinch/rubyext/module.rb
-- lib/cinch/rubyext/queue.rb
-- lib/cinch/rubyext/infinity.rb
+- lib/cinch/rubyext/float.rb
 - lib/cinch/rubyext/string.rb
+- lib/cinch/syncable.rb
+- lib/cinch/plugin_list.rb
+- lib/cinch/message.rb
+- lib/cinch/target.rb
 - lib/cinch/mask.rb
-- lib/cinch/plugin.rb
-- lib/cinch/exceptions.rb
+- lib/cinch/configuration/sasl.rb
+- lib/cinch/configuration/bot.rb
+- lib/cinch/configuration/storage.rb
+- lib/cinch/configuration/plugins.rb
+- lib/cinch/configuration/ssl.rb
+- lib/cinch/configuration/dcc.rb
+- lib/cinch/configuration/timeouts.rb
+- lib/cinch/pattern.rb
+- lib/cinch/open_ended_queue.rb
+- lib/cinch/logger_list.rb
+- lib/cinch/callback.rb
+- lib/cinch/dcc.rb
+- lib/cinch/version.rb
+- lib/cinch/utilities/deprecation.rb
+- lib/cinch/utilities/kernel.rb
+- lib/cinch/utilities/string.rb
+- lib/cinch/utilities/encoding.rb
+- lib/cinch/constants.rb
 - lib/cinch/mode_parser.rb
+- lib/cinch/user.rb
+- lib/cinch/storage/yaml.rb
+- lib/cinch/storage/null.rb
+- lib/cinch/logger/formatted_logger.rb
+- lib/cinch/logger/zcbot_logger.rb
+- lib/cinch/exceptions.rb
+- lib/cinch/logger.rb
+- lib/cinch/plugin.rb
+- lib/cinch/user_list.rb
+- lib/cinch/dcc/incoming/send.rb
+- lib/cinch/dcc/dccable_object.rb
+- lib/cinch/dcc/outgoing.rb
+- lib/cinch/dcc/incoming.rb
+- lib/cinch/dcc/outgoing/send.rb
+- lib/cinch/irc.rb
+- lib/cinch/channel_list.rb
+- lib/cinch/ban.rb
+- lib/cinch/message_queue.rb
+- lib/cinch/configuration.rb
+- lib/cinch.rb
+- examples/plugins/timer.rb
 - examples/plugins/msg.rb
-- examples/plugins/memo.rb
-- examples/plugins/urban_dict.rb
-- examples/plugins/last_nick.rb
-- examples/plugins/join_part.rb
+- examples/plugins/dice_roll.rb
 - examples/plugins/lambdas.rb
-- examples/plugins/timer.rb
-- examples/plugins/url_shorten.rb
+- examples/plugins/join_part.rb
+- examples/plugins/google.rb
+- examples/plugins/autovoice.rb
 - examples/plugins/multiple_matches.rb
-- examples/plugins/hello.rb
+- examples/plugins/url_shorten.rb
+- examples/plugins/memo.rb
 - examples/plugins/own_events.rb
 - examples/plugins/seen.rb
-- examples/plugins/custom_prefix.rb
-- examples/plugins/google.rb
-- examples/plugins/autovoice.rb
+- examples/plugins/last_nick.rb
+- examples/plugins/urban_dict.rb
 - examples/plugins/hooks.rb
+- examples/plugins/hello.rb
+- examples/plugins/custom_prefix.rb
 - examples/basic/msg.rb
-- examples/basic/memo.rb
-- examples/basic/urban_dict.rb
 - examples/basic/join_part.rb
-- examples/basic/url_shorten.rb
-- examples/basic/hello.rb
-- examples/basic/seen.rb
 - examples/basic/google.rb
 - examples/basic/autovoice.rb
-has_rdoc: true
-homepage: http://rubydoc.info/github/cinchrb/cinch
+- examples/basic/url_shorten.rb
+- examples/basic/memo.rb
+- examples/basic/seen.rb
+- examples/basic/urban_dict.rb
+- examples/basic/hello.rb
+homepage: http://cinchrb.org
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -93,13 +133,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: An IRC Bot Building Framework
 test_files: []
+has_rdoc: yard

data/lib/cinch/logger/logger.rb

@@ -1,44 +0,0 @@
-module Cinch
-  module Logger
-    # This is an abstract class describing the logger interface. All
-    # loggers should inherit from this class and provide all necessary
-    # methods.
-    #
-    # Note: You cannot initialize this class directly.
-    #
-    # @abstract
-    class Logger
-      def initialize(output)
-        raise
-      end
-
-      # This method can be used by plugins to log custom messages.
-      #
-      # @param [String] message The message to log
-      # @return [void]
-      def debug(message)
-        raise
-      end
-
-      # This method is used by {#debug} and {#log_exception} to log
-      # messages, and also by the IRC parser to log incoming and
-      # outgoing messages. You should not have to call this.
-      #
-      # @param [String] message The message to log
-      # @param [Symbol<:debug, :generic, :incoming, :outgoing>] kind
-      #   The kind of message to log
-      # @return [void]
-      def log(message, kind = :generic)
-        raise
-      end
-
-      # This method is used for logging messages.
-      #
-      # @param [Exception] e The exception to log
-      # @return [void]
-      def log_exception(e)
-        raise
-      end
-    end
-  end
-end

data/lib/cinch/logger/null_logger.rb

@@ -1,18 +0,0 @@
-require "cinch/logger/logger"
-module Cinch
-  module Logger
-    class NullLogger < Cinch::Logger::Logger
-      def initialize(output = nil)
-      end
-
-      def debug(message)
-      end
-
-      def log(message, kind = :generic)
-      end
-
-      def log_exception(e)
-      end
-    end
-  end
-end

data/lib/cinch/rubyext/infinity.rb

@@ -1 +0,0 @@
-Infinity = 1.0/0.0