grinch 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 599ce33b0690279ec66619db60107d39af1085244c24488e99e8b7463a9bf997
-  data.tar.gz: '097b6c4e200d0bc3ec0c953d39c55c9ff99a948e9ff57c34a95c04be776ddae5'
+  metadata.gz: ff1fe47fa67c86ef5ffa119522fa4ae6f9196a190a2a6ebc06a0a4092c4aa0cc
+  data.tar.gz: dc959561efa0b7308b136b12faaeb7ef1cc9740a90c624ef1109f4bfb0899806
 SHA512:
-  metadata.gz: 7f58e236d6481c75f145f0792c0629822d173b6780b7ed050c24d997b15816d9360ffe989fc4b10ceb49fff95a255aeb81b4ad128017c046def8e06889f92f40
-  data.tar.gz: 1c1f1b6d39f4d25f9a9ed0a88725d325dd6690e87f446c41a68833d168243144852d1bbd7ae2995089e671157781de3b55d19b528f5fc05a9de2cab6d50363fe
+  metadata.gz: 0daf1149621659966dff2f012dc9f0cb156dd9cf381620715e67007e9aca65d83c01170e6d876a7deb9a8501571b6aa3cf7ea6a89ab47be09c015c67e303fa18
+  data.tar.gz: 2705dad2d060be73599612208455b70aecce4c22eef3f230090ca829964313549d2e232ea86ecef980e5804da062c5a94330640a501bf44b6a0ad2f1c8c8a038

data/README.md

@@ -1,6 +1,8 @@
 Grinch - The IRC Bot Building Framework
 =====================================
 
+[![Build Status](https://travis-ci.org/grinchrb/grinch.svg?branch=master)](https://travis-ci.org/grinchrb/grinch)
+
 **WARNING!**
 
 Grinch is a *lightly* maintained fork of [Cinch](https://github.com/cinchrb/cinch/), which
@@ -172,8 +174,8 @@ is missing that awesome jaw-dropping feature and you want to be the one to
 make this magic happen, you can!
 
 Please note that although we very much appreciate all of your efforts, Grinch
-will not accept patches in aid of Ruby 1.8 compatibility. We have no intention
-of supporting Ruby versions below 1.9.1.
+will not accept patches in aid of Ruby 2.5 compatibility. We have no intention
+of supporting Ruby versions below 2.5.
 
 Fork the project, implement your awesome feature in its own branch, and send
 a pull request to one of the Grinch collaborators. We'll be more than happy

data/lib/cinch.rb

@@ -1,5 +1,7 @@
-require 'cinch/version'
-require 'cinch/utilities/kernel'
-require 'cinch/utilities/deprecation'
-require 'cinch/utilities/encoding'
-require 'cinch/bot'
+# frozen_string_literal: true
+
+require "cinch/version"
+require "cinch/utilities/kernel"
+require "cinch/utilities/deprecation"
+require "cinch/utilities/encoding"
+require "cinch/bot"

data/lib/cinch/ban.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "cinch/mask"
 module Cinch
   # This class represents channel bans.
@@ -23,7 +25,8 @@ module Cinch
     # @param [User, nil] by The user who created the ban.
     # @param [Time] at The time at which the ban was created
     def initialize(mask, by, at)
-      @by, @created_at = by, at
+      @by = by
+      @created_at = at
       if mask =~ /^[\$~]/
         @extended = true
         @mask     = mask
@@ -38,9 +41,10 @@ module Cinch
     #   Freenode's extended bans
     def match(user)
       raise UnsupportedFeature, "extended bans are not supported yet" if @extended
+
       @mask =~ user
     end
-    alias_method :=~, :match
+    alias =~ match
 
     # @return [String]
     def to_s

data/lib/cinch/bot.rb

@@ -1,6 +1,6 @@
-# -*- coding: utf-8 -*-
-require 'socket'
-require "thread"
+# frozen_string_literal: true
+
+require "socket"
 require "ostruct"
 require "cinch/rubyext/module"
 require "cinch/rubyext/string"
@@ -56,7 +56,6 @@ module Cinch
   class Bot < User
     include Helpers
 
-
     # @return [Configuration::Bot]
     # @version 2.0.0
     attr_reader :config
@@ -200,10 +199,10 @@ module Cinch
                   end
                 end
 
-      handler = Handler.new(self, event, pattern, {args: args, execute_in_callback: true}, &block)
+      handler = Handler.new(self, event, pattern, { args: args, execute_in_callback: true }, &block)
       @handlers.register(handler)
 
-      return handler
+      handler
     end
 
     # @endgroup
@@ -244,26 +243,24 @@ module Cinch
           user.unsync_all
         end # reset state of all users
 
-        @channel_list.each do |channel|
-          channel.unsync_all
-        end # reset state of all channels
+        @channel_list.each(&:unsync_all) # reset state of all channels
 
         @channels = [] # reset list of channels the bot is in
 
-        @join_handler.unregister if @join_handler
-        @join_timer.stop if @join_timer
+        @join_handler&.unregister
+        @join_timer&.stop
 
-        join_lambda = lambda { @config.channels.each { |channel| Channel(channel).join }}
+        join_lambda = -> { @config.channels.each { |channel| Channel(channel).join } }
 
         if @config.delay_joins.is_a?(Symbol)
-          @join_handler = join_handler = on(@config.delay_joins) {
+          @join_handler = join_handler = on(@config.delay_joins) do
             join_handler.unregister
             join_lambda.call
-          }
+          end
         else
-          @join_timer = Timer.new(self, interval: @config.delay_joins, shots: 1) {
+          @join_timer = Timer.new(self, interval: @config.delay_joins, shots: 1) do
             join_lambda.call
-          }
+          end
         end
 
         @modes = []
@@ -286,11 +283,9 @@ module Cinch
           wait = @config.max_reconnect_delay if wait > @config.max_reconnect_delay
           @loggers.info "Waiting #{wait} seconds before reconnecting"
           start_time = Time.now
-          while !@quitting && (Time.now - start_time) < wait
-            sleep 1
-          end
+          sleep 1 while !@quitting && (Time.now - start_time) < wait
         end
-      end while @config.reconnect and not @quitting
+      end while @config.reconnect && !@quitting
     end
 
     # @endgroup
@@ -332,11 +327,11 @@ module Cinch
 
     # @yield
     def initialize(&b)
-      @config           = Configuration::Bot.new
+      @config = Configuration::Bot.new
 
       @loggers = LoggerList.new
       @loggers << Logger::FormattedLogger.new($stderr, level: @config.default_logger_level)
-      @handlers         = HandlerList.new
+      @handlers = HandlerList.new
       @semaphores_mutex = Mutex.new
       @semaphores       = Hash.new { |h, k| h[k] = Mutex.new }
       @callback         = Callback.new(self)
@@ -419,9 +414,8 @@ module Cinch
     end
 
     def nick=(new_nick)
-      if new_nick.size > @irc.isupport["NICKLEN"] && strict?
-        raise Exceptions::NickTooLong, new_nick
-      end
+      raise Exceptions::NickTooLong, new_nick if new_nick.size > @irc.isupport["NICKLEN"] && strict?
+
       @config.nick = new_nick
       @irc.send "NICK #{new_nick}"
     end
@@ -434,7 +428,7 @@ module Cinch
     # @since 2.1.0
     # @return [void]
     def oper(password, user = nil)
-      user ||= self.nick
+      user ||= nick
       @irc.send "OPER #{user} #{password}"
     end
 
@@ -457,11 +451,7 @@ module Cinch
           # if we have a base, try the next nick or append an
           # underscore if no more nicks are left
           new_index = nicks.index(base) + 1
-          if nicks[new_index]
-            new_nick = nicks[new_index]
-          else
-            new_nick = base + "_"
-          end
+          new_nick = nicks[new_index] || base + "_"
         end
       else
         # if we have no base, try the first possible nick

data/lib/cinch/cached_list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cinch
   # @api private
   # @since 2.0.0

data/lib/cinch/callback.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cinch
   # Class used for encapsulating handlers to prevent them from
   # overwriting instance variables in {Bot}

data/lib/cinch/channel.rb

@@ -1,4 +1,5 @@
-# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
 require "set"
 require "cinch/target"
 
@@ -49,24 +50,24 @@ module Cinch
     def initialize(name, bot)
       @bot    = bot
       @name   = name
-      @users  = Hash.new {|h, k| h[k] = []}
+      @users  = Hash.new { |h, k| h[k] = [] }
       @bans   = []
       @owners = []
 
       @modes = {}
-      # TODO raise if not a channel
+      # TODO: raise if not a channel
 
       @topic = nil
 
       @in_channel = false
 
-      @synced_attributes  = Set.new
-      @when_requesting_synced_attribute = lambda {|attr|
+      @synced_attributes = Set.new
+      @when_requesting_synced_attribute = lambda { |attr|
         if @in_channel && attr == :topic && !attribute_synced?(:topic)
           # Even if we are in the channel, if there's no topic set,
           # the attribute won't be synchronised yet. Explicitly
           # request the topic.
-          @bot.irc.send "TOPIC #@name"
+          @bot.irc.send "TOPIC #{@name}"
           next
         end
 
@@ -74,21 +75,21 @@ module Cinch
           unsync(attr)
           case attr
           when :users
-            @bot.irc.send "NAMES #@name"
+            @bot.irc.send "NAMES #{@name}"
           when :topic
-            @bot.irc.send "TOPIC #@name"
+            @bot.irc.send "TOPIC #{@name}"
           when :bans
-            @bot.irc.send "MODE #@name +b"
+            @bot.irc.send "MODE #{@name} +b"
           when :owners
             if @bot.irc.network.owner_list_mode
-              @bot.irc.send "MODE #@name +#{@bot.irc.network.owner_list_mode}"
+              @bot.irc.send "MODE #{@name} +#{@bot.irc.network.owner_list_mode}"
             else
               # the current IRCd does not support channel owners, so
               # just mark the empty array as synced
               mark_as_synced(:owners)
             end
           when :modes
-            @bot.irc.send "MODE #@name"
+            @bot.irc.send "MODE #{@name}"
           end
         end
       }
@@ -101,7 +102,7 @@ module Cinch
     # @since 1.1.0
     # @version 1.1.2
     def has_user?(user)
-      @users.has_key?(User(user))
+      @users.key?(User(user))
     end
 
     # @return [Boolean] true if `user` is opped in the channel
@@ -128,25 +129,25 @@ module Cinch
     # @return [Array<User>] All ops in the channel
     # @since 2.0.0
     def ops
-      @users.select {|user, modes| modes.include?("o")}.keys
+      @users.select { |_user, modes| modes.include?("o") }.keys
     end
 
     # @return [Array<User>] All half-ops in the channel
     # @since 2.0.0
     def half_ops
-      @users.select {|user, modes| modes.include?("h")}.keys
+      @users.select { |_user, modes| modes.include?("h") }.keys
     end
 
     # @return [Array<User>] All voiced users in the channel
     # @since 2.0.0
     def voiced
-      @users.select {|user, modes| modes.include?("v")}.keys
+      @users.select { |_user, modes| modes.include?("v") }.keys
     end
 
     # @return [Array<User>] All admins in the channel
     # @since 2.0.0
     def admins
-      @users.select {|user, modes| modes.include?("a")}.keys
+      @users.select { |_user, modes| modes.include?("a") }.keys
     end
     # @endgroup
 
@@ -157,7 +158,7 @@ module Cinch
     end
 
     def limit=(val)
-      if val == -1 or val.nil?
+      if (val == -1) || val.nil?
         mode "-l"
       else
         mode "+l #{val}"
@@ -168,7 +169,7 @@ module Cinch
     def secret
       @modes["s"]
     end
-    alias_method :secret?, :secret
+    alias secret? secret
 
     def secret=(bool)
       if bool
@@ -182,7 +183,7 @@ module Cinch
     def moderated
       @modes["m"]
     end
-    alias_method :moderated?, :moderated
+    alias moderated? moderated
 
     def moderated=(bool)
       if bool
@@ -196,7 +197,7 @@ module Cinch
     def invite_only
       @modes["i"]
     end
-    alias_method :invite_only?, :invite_only
+    alias invite_only? invite_only
 
     def invite_only=(bool)
       if bool
@@ -228,14 +229,14 @@ module Cinch
       unsync :owners
 
       if @bot.irc.isupport["WHOX"]
-        @bot.irc.send "WHO #@name %acfhnru"
+        @bot.irc.send "WHO #{@name} %acfhnru"
       else
-        @bot.irc.send "WHO #@name"
+        @bot.irc.send "WHO #{@name}"
       end
-      @bot.irc.send "MODE #@name +b" # bans
-      @bot.irc.send "MODE #@name"
+      @bot.irc.send "MODE #{@name} +b" # bans
+      @bot.irc.send "MODE #{@name}"
       if @bot.irc.network.owner_list_mode
-        @bot.irc.send "MODE #@name +#{@bot.irc.network.owner_list_mode}"
+        @bot.irc.send "MODE #{@name} +#{@bot.irc.network.owner_list_mode}"
       else
         mark_as_synced :owners
       end
@@ -251,7 +252,7 @@ module Cinch
     def ban(target)
       mask = Mask.from(target)
 
-      @bot.irc.send "MODE #@name +b #{mask}"
+      @bot.irc.send "MODE #{@name} +b #{mask}"
       mask
     end
 
@@ -263,7 +264,7 @@ module Cinch
     def unban(target)
       mask = Mask.from(target)
 
-      @bot.irc.send "MODE #@name -b #{mask}"
+      @bot.irc.send "MODE #{@name} -b #{mask}"
       mask
     end
 
@@ -272,7 +273,7 @@ module Cinch
     # @param [String, User] user the user to op
     # @return [void]
     def op(user)
-      @bot.irc.send "MODE #@name +o #{user}"
+      @bot.irc.send "MODE #{@name} +o #{user}"
     end
 
     # Deops a user.
@@ -280,7 +281,7 @@ module Cinch
     # @param [String, User] user the user to deop
     # @return [void]
     def deop(user)
-      @bot.irc.send "MODE #@name -o #{user}"
+      @bot.irc.send "MODE #{@name} -o #{user}"
     end
 
     # Voices a user.
@@ -288,7 +289,7 @@ module Cinch
     # @param [String, User] user the user to voice
     # @return [void]
     def voice(user)
-      @bot.irc.send "MODE #@name +v #{user}"
+      @bot.irc.send "MODE #{@name} +v #{user}"
     end
 
     # Devoices a user.
@@ -296,7 +297,7 @@ module Cinch
     # @param [String, User] user the user to devoice
     # @return [void]
     def devoice(user)
-      @bot.irc.send "MODE #@name -v #{user}"
+      @bot.irc.send "MODE #{@name} -v #{user}"
     end
 
     # Invites a user to the channel.
@@ -304,7 +305,7 @@ module Cinch
     # @param [String, User] user the user to invite
     # @return [void]
     def invite(user)
-      @bot.irc.send("INVITE #{user} #@name")
+      @bot.irc.send("INVITE #{user} #{@name}")
     end
 
     undef_method(:topic=)
@@ -318,7 +319,7 @@ module Cinch
         raise Exceptions::TopicTooLong, new_topic
       end
 
-      @bot.irc.send "TOPIC #@name :#{new_topic}"
+      @bot.irc.send "TOPIC #{@name} :#{new_topic}"
     end
 
     # Kicks a user from the channel.
@@ -332,7 +333,7 @@ module Cinch
         raise Exceptions::KickReasonTooLong, reason
       end
 
-      @bot.irc.send("KICK #@name #{user} :#{reason}")
+      @bot.irc.send("KICK #{@name} #{user} :#{reason}")
     end
 
     # Removes a user from the channel.
@@ -347,7 +348,7 @@ module Cinch
     # @param [String] reason a reason for the removal
     # @return [void]
     def remove(user, reason = nil)
-      @bot.irc.send("REMOVE #@name #{user} :#{reason}")
+      @bot.irc.send("REMOVE #{@name} #{user} :#{reason}")
     end
 
     # Sets or unsets modes. Most of the time you won't need this but
@@ -358,7 +359,7 @@ module Cinch
     # @example
     #   channel.mode "+n"
     def mode(s)
-      @bot.irc.send "MODE #@name #{s}"
+      @bot.irc.send "MODE #{@name} #{s}"
     end
 
     # Causes the bot to part from the channel.
@@ -366,7 +367,7 @@ module Cinch
     # @param [String] message the part message.
     # @return [void]
     def part(message = nil)
-      @bot.irc.send "PART #@name :#{message}"
+      @bot.irc.send "PART #{@name} :#{message}"
     end
 
     # Joins the channel
@@ -375,9 +376,7 @@ module Cinch
     #   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
+      key = self.key if key.nil? && (self.key != true)
       @bot.irc.send "JOIN #{[@name, key].compact.join(" ")}"
     end
 
@@ -409,7 +408,7 @@ module Cinch
     # @note The aliases `msg` and `privmsg` are deprecated and will be
     #   removed in a future version.
     def send(text, notice = false)
-      # TODO deprecate 'notice' argument
+      # TODO: deprecate 'notice' argument
       text = text.to_s
       if @modes["c"]
         # Remove all formatting and colors if the channel doesn't
@@ -418,8 +417,8 @@ module Cinch
       end
       super(text, notice)
     end
-    alias_method :msg, :send # deprecated
-    alias_method :privmsg, :send # deprecated
+    alias msg send # deprecated
+    alias privmsg send # deprecated
     undef_method(:msg) # yardoc hack
     undef_method(:privmsg) # yardoc hack
 
@@ -447,7 +446,7 @@ module Cinch
     def to_s
       @name
     end
-    alias_method :to_str, :to_s # deprecated
+    alias to_str to_s # deprecated
     undef_method(:to_str) # yardoc hack
 
     def to_str