grinch 1.0.0

data/lib/cinch/user_list.rb

@@ -0,0 +1,87 @@
+require "cinch/cached_list"
+
+module Cinch
+  # @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 their nick.
+    #
+    #   @param [String] nick The user's nickname
+    #   @return [User]
+    # @overload find_ensured(user, nick, host)
+    #   Finds or creates a user based on their 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)
+      user, host = nil, nil
+      case args.size
+      when 1
+        nick = args.first
+        bargs = [nick]
+      when 3
+        nick = args[1]
+        bargs = args
+        user, _, host = bargs
+      else
+        raise ArgumentError
+      end
+
+      if nick == @bot.nick
+        user_obj = @bot
+      end
+
+      downcased_nick = nick.irc_downcase(@bot.irc.isupport["CASEMAPPING"])
+      @mutex.synchronize do
+        if user_obj.nil?
+          user_obj = @cache[downcased_nick] ||= User.new(*bargs, @bot)
+        end
+        if user && host
+          # Explicitly set user and host whenever we request a User
+          # object to update them on e.g. JOIN.
+          user_obj.sync(:user, user, true)
+          user_obj.sync(:host, host, true)
+        end
+        user_obj
+      end
+    end
+
+    # Finds a user.
+    #
+    # @param [String] nick nick of a user
+    # @return [User, nil]
+    def find(nick)
+      if nick == @bot.nick
+        return @bot
+      end
+
+      downcased_nick = nick.irc_downcase(@bot.irc.isupport["CASEMAPPING"])
+      @mutex.synchronize do
+        return @cache[downcased_nick]
+      end
+    end
+
+    # @api private
+    # @return [void]
+    def update_nick(user)
+      @mutex.synchronize do
+        @cache.delete user.last_nick.irc_downcase(@bot.irc.isupport["CASEMAPPING"])
+        @cache[user.nick.irc_downcase(@bot.irc.isupport["CASEMAPPING"])] = user
+      end
+    end
+
+    # @api private
+    # @return [void]
+    def delete(user)
+      @cache.delete_if {|n, u| u == user }
+    end
+  end
+end

data/lib/cinch/utilities/deprecation.rb

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

data/lib/cinch/utilities/encoding.rb

@@ -0,0 +1,37 @@
+module Cinch
+  module Utilities
+    # @since 2.0.0
+    # @api private
+    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
+          encoding = "UTF-8"
+        end
+
+        return string.encode!(encoding, {:invalid => :replace, :undef => :replace}).force_encoding("ASCII-8BIT")
+      end
+    end
+  end
+end

data/lib/cinch/utilities/kernel.rb

@@ -0,0 +1,13 @@
+module Cinch
+  module Utilities
+    # @since 2.0.0
+    # @api private
+    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/version.rb

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

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: grinch
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- William Woodruff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-29 00:00:00.000000000 Z
+dependencies: []
+description: A simple, friendly DSL for creating IRC bots
+email:
+- william@yossarian.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- LICENSE
+- README.md
+- docs/bot_options.md
+- docs/changes.md
+- docs/common_mistakes.md
+- docs/common_tasks.md
+- docs/encodings.md
+- docs/events.md
+- docs/getting_started.md
+- docs/logging.md
+- docs/migrating.md
+- docs/plugins.md
+- docs/readme.md
+- examples/basic/autovoice.rb
+- examples/basic/google.rb
+- examples/basic/hello.rb
+- examples/basic/join_part.rb
+- examples/basic/memo.rb
+- examples/basic/msg.rb
+- examples/basic/seen.rb
+- examples/basic/urban_dict.rb
+- examples/basic/url_shorten.rb
+- examples/plugins/autovoice.rb
+- examples/plugins/custom_prefix.rb
+- examples/plugins/dice_roll.rb
+- examples/plugins/google.rb
+- examples/plugins/hello.rb
+- examples/plugins/hooks.rb
+- examples/plugins/join_part.rb
+- examples/plugins/lambdas.rb
+- examples/plugins/last_nick.rb
+- examples/plugins/msg.rb
+- examples/plugins/multiple_matches.rb
+- examples/plugins/own_events.rb
+- examples/plugins/seen.rb
+- examples/plugins/timer.rb
+- examples/plugins/url_shorten.rb
+- lib/cinch.rb
+- lib/cinch/ban.rb
+- lib/cinch/bot.rb
+- lib/cinch/cached_list.rb
+- lib/cinch/callback.rb
+- lib/cinch/channel.rb
+- lib/cinch/channel_list.rb
+- lib/cinch/configuration.rb
+- lib/cinch/configuration/bot.rb
+- lib/cinch/configuration/dcc.rb
+- lib/cinch/configuration/plugins.rb
+- lib/cinch/configuration/sasl.rb
+- lib/cinch/configuration/ssl.rb
+- lib/cinch/configuration/timeouts.rb
+- lib/cinch/constants.rb
+- lib/cinch/dcc.rb
+- lib/cinch/dcc/dccable_object.rb
+- lib/cinch/dcc/incoming.rb
+- lib/cinch/dcc/incoming/send.rb
+- lib/cinch/dcc/outgoing.rb
+- lib/cinch/dcc/outgoing/send.rb
+- lib/cinch/exceptions.rb
+- lib/cinch/formatting.rb
+- lib/cinch/handler.rb
+- lib/cinch/handler_list.rb
+- lib/cinch/helpers.rb
+- lib/cinch/irc.rb
+- lib/cinch/isupport.rb
+- lib/cinch/log_filter.rb
+- lib/cinch/logger.rb
+- lib/cinch/logger/formatted_logger.rb
+- lib/cinch/logger/zcbot_logger.rb
+- lib/cinch/logger_list.rb
+- lib/cinch/mask.rb
+- lib/cinch/message.rb
+- lib/cinch/message_queue.rb
+- lib/cinch/mode_parser.rb
+- lib/cinch/network.rb
+- lib/cinch/open_ended_queue.rb
+- lib/cinch/pattern.rb
+- lib/cinch/plugin.rb
+- lib/cinch/plugin_list.rb
+- lib/cinch/rubyext/float.rb
+- lib/cinch/rubyext/module.rb
+- lib/cinch/rubyext/string.rb
+- lib/cinch/sasl.rb
+- lib/cinch/sasl/dh_blowfish.rb
+- lib/cinch/sasl/diffie_hellman.rb
+- lib/cinch/sasl/mechanism.rb
+- lib/cinch/sasl/plain.rb
+- lib/cinch/syncable.rb
+- lib/cinch/target.rb
+- lib/cinch/timer.rb
+- lib/cinch/user.rb
+- lib/cinch/user_list.rb
+- lib/cinch/utilities/deprecation.rb
+- lib/cinch/utilities/encoding.rb
+- lib/cinch/utilities/kernel.rb
+- lib/cinch/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: An IRC Bot Building Framework
+test_files: []