grinch 1.0.1 → 1.1.0

data/lib/cinch/target.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cinch
   # @since 2.0.0
   class Target
@@ -30,7 +32,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, put splitting into own
+      # TODO: deprecate `notice` argument, put splitting into own
       # method
       text = text.to_s
       split_start = @bot.config.message_split_start || ""
@@ -42,12 +44,12 @@ module Cinch
         splitted = split_message(line, prefix, split_start, split_end)
 
         splitted[0, (@bot.config.max_messages || splitted.size)].each do |string|
-          @bot.irc.send("#{command} #@name :#{string}")
+          @bot.irc.send("#{command} #{@name} :#{string}")
         end
       end
     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
 
@@ -78,8 +80,8 @@ module Cinch
     def safe_send(text, notice = false)
       send(Cinch::Helpers.sanitize(text), notice)
     end
-    alias_method :safe_msg, :safe_send # deprecated
-    alias_method :safe_privmsg, :safe_msg # deprecated
+    alias safe_msg safe_send # deprecated
+    alias safe_privmsg safe_msg # deprecated
     undef_method(:safe_msg) # yardoc hack
     undef_method(:safe_privmsg) # yardoc hack
 
@@ -95,7 +97,6 @@ module Cinch
       send(*args)
     end
 
-
     # Like {#safe_msg} but for notices.
     #
     # @return (see #safe_msg)
@@ -113,7 +114,7 @@ module Cinch
     # @see #safe_action
     def action(text)
       line = text.to_s.each_line.first.chomp
-      @bot.irc.send("PRIVMSG #@name :\001ACTION #{line}\001")
+      @bot.irc.send("PRIVMSG #{@name} :\001ACTION #{line}\001")
     end
 
     # Like {#action}, but remove any non-printable characters from
@@ -163,28 +164,25 @@ module Cinch
         left <=> other.name.irc_downcase(casemapping)
       elsif other.is_a?(String)
         left <=> other.irc_downcase(casemapping)
-      else
-        nil
       end
     end
 
     private
+
     def split_message(msg, prefix, split_start, split_end)
       max_bytesize = 510 - prefix.bytesize
       max_bytesize_without_end = max_bytesize - split_end.bytesize
 
-      if msg.bytesize <= max_bytesize
-        return [msg]
-      end
+      return [msg] if msg.bytesize <= max_bytesize
 
       splitted = []
       while msg.bytesize > max_bytesize_without_end
         acc = 0
-        acc_rune_sizes = msg.each_char.map {|ch|
+        acc_rune_sizes = msg.each_char.map do |ch|
           acc += ch.bytesize
-        }
+        end
 
-        max_rune = acc_rune_sizes.rindex {|bs| bs <= max_bytesize_without_end} || 0
+        max_rune = acc_rune_sizes.rindex { |bs| bs <= max_bytesize_without_end } || 0
         r = [msg.rindex(/\s/, max_rune) || (max_rune + 1), 1].max
 
         splitted << (msg[0...r] + split_end)
@@ -193,7 +191,7 @@ module Cinch
       splitted << msg
 
       # clean string from any substitute characters
-      splitted.map {|string| string.tr("\cz", " ")}
+      splitted.map { |string| string.tr("\cz", " ") }
     end
   end
 end

data/lib/cinch/timer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "cinch/helpers"
 
 module Cinch
@@ -41,8 +43,8 @@ module Cinch
     #   will stop. This value will automatically reset after
     #   restarting the timer.
     attr_accessor :shots
-    alias_method :threaded?, :threaded
-    alias_method :started?, :started
+    alias threaded? threaded
+    alias started? started
 
     # @return [ThreadGroup]
     # @api private
@@ -62,7 +64,7 @@ module Cinch
     # @option options [Boolean] :stop_automaticall (true) If true, the
     #   timer will automatically stop when the bot disconnects.
     def initialize(bot, options, &block)
-      options = {:threaded => true, :shots => Float::INFINITY, :start_automatically => true, :stop_automatically => true}.merge(options)
+      options = { threaded: true, shots: Float::INFINITY, start_automatically: true, stop_automatically: true }.merge(options)
 
       @bot        = bot
       @interval   = options[:interval].to_f
@@ -76,13 +78,13 @@ module Cinch
       @thread_group = ThreadGroup.new
 
       if options[:start_automatically]
-        @bot.on :connect, //, self do |m, timer|
+        @bot.on :connect, //, self do |_m, timer|
           timer.start
         end
       end
 
       if options[:stop_automatically]
-        @bot.on :disconnect, //, self do |m, timer|
+        @bot.on :disconnect, //, self do |_m, timer|
           timer.stop
         end
       end
@@ -104,7 +106,7 @@ module Cinch
       @shots = @orig_shots
 
       @thread_group.add Thread.new {
-        while @shots > 0 do
+        while @shots > 0
           sleep @interval
           if threaded?
             Thread.new do
@@ -133,7 +135,7 @@ module Cinch
 
       @bot.loggers.debug "[timer] Stopping timer #{self}"
 
-      @thread_group.list.each { |thread| thread.kill }
+      @thread_group.list.each(&:kill)
       @started = false
     end
 

data/lib/cinch/user.rb

@@ -1,4 +1,5 @@
-# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
 require "cinch/target"
 require "timeout"
 
@@ -37,7 +38,7 @@ module Cinch
     # @return [Boolean]
     attr_reader :synced
     # @since 2.1.0
-    alias_method :synced?, :synced
+    alias synced? synced
 
     # @return [Boolean]
     # @api private
@@ -74,7 +75,7 @@ module Cinch
     def unknown
       attr(:unknown?, true, false)
     end
-    alias_method :unknown?, :unknown
+    alias unknown? unknown
 
     # @note This attribute will be updated by various events, but
     # unless {#monitor} is being used, this information cannot be
@@ -82,7 +83,7 @@ module Cinch
     def online
       attr(:online?, true, false)
     end
-    alias_method :online?, :online
+    alias online? online
 
     def channels
       attr(:channels, true, false)
@@ -91,13 +92,13 @@ module Cinch
     def secure
       attr(:secure?, true, false)
     end
-    alias_method :secure?, :secure
+    alias secure? secure
 
     # @since 2.1.0
     def oper
       attr(:oper?, true, false)
     end
-    alias_method :oper?, :oper
+    alias oper? oper
 
     # @private
     def user_unsynced
@@ -180,7 +181,7 @@ module Cinch
     # @note The attribute writer is in fact part of the private API
     attr_reader :monitored
     # @since 2.1.0
-    alias_method :monitored?, :monitored
+    alias monitored? monitored
 
     # @api private
     attr_writer :monitored
@@ -189,18 +190,18 @@ module Cinch
     #   class. Use {UserList#find_ensured} instead.
     def initialize(*args)
       @data = {
-        :user         => nil,
-        :host         => nil,
-        :realname     => nil,
-        :authname     => nil,
-        :idle         => 0,
-        :signed_on_at => nil,
-        :unknown?     => false,
-        :online?      => false,
-        :channels     => [],
-        :secure?      => false,
-        :away         => nil,
-        :oper?        => false,
+        user: nil,
+        host: nil,
+        realname: nil,
+        authname: nil,
+        idle: 0,
+        signed_on_at: nil,
+        unknown?: false,
+        online?: false,
+        channels: [],
+        secure?: false,
+        away: nil,
+        oper?: false,
       }
       case args.size
       when 2
@@ -211,9 +212,9 @@ module Cinch
         raise ArgumentError
       end
 
-      @synced_attributes  = Set.new
+      @synced_attributes = Set.new
 
-      @when_requesting_synced_attribute = lambda {|attr|
+      @when_requesting_synced_attribute = lambda { |attr|
         unless attribute_synced?(attr)
           @data[:unknown?] = false
           unsync :unknown?
@@ -248,18 +249,19 @@ module Cinch
     #   future version.
     def refresh
       return if @in_whois
+
       @data.keys.each do |attr|
         unsync attr
       end
 
       @in_whois = true
       if @bot.irc.network.whois_only_one_argument?
-        @bot.irc.send "WHOIS #@name"
+        @bot.irc.send "WHOIS #{@name}"
       else
-        @bot.irc.send "WHOIS #@name #@name"
+        @bot.irc.send "WHOIS #{@name} #{@name}"
       end
     end
-    alias_method :whois, :refresh # deprecated
+    alias whois refresh # deprecated
     undef_method(:whois) # yardoc hack
 
     # @deprecated
@@ -303,16 +305,16 @@ module Cinch
       end
 
       if values[:registered]
-        values[:authname] ||= self.nick
+        values[:authname] ||= nick
         values.delete(:registered)
       end
       {
-        :authname => nil,
-        :idle     => 0,
-        :secure?  => false,
-        :oper?    => false,
-        :away     => nil,
-        :channels => [],
+        authname: nil,
+        idle: 0,
+        secure?: false,
+        oper?: false,
+        away: nil,
+        channels: [],
       }.merge(values).each do |attr, value|
         sync(attr, value, true)
       end
@@ -351,20 +353,20 @@ module Cinch
     #
     # @return [Mask]
     def mask(s = "%n!%u@%h")
-      s = s.gsub(/%(.)/) {
-        case $1
+      s = s.gsub(/%(.)/) do
+        case Regexp.last_match(1)
         when "n"
           @name
         when "u"
-          self.user
+          user
         when "h"
-          self.host
+          host
         when "r"
-          self.realname
+          realname
         when "a"
-          self.authname
+          authname
         end
-      }
+      end
 
       Mask.new(s)
     end
@@ -376,7 +378,7 @@ module Cinch
     def match(other)
       Mask.from(other) =~ Mask.from(self)
     end
-    alias_method :=~, :match
+    alias =~ match
 
     # Starts monitoring a user's online state by either using MONITOR
     # or periodically running WHOIS.
@@ -386,12 +388,12 @@ module Cinch
     # @see #unmonitor
     def monitor
       if @bot.irc.isupport["MONITOR"] > 0
-        @bot.irc.send "MONITOR + #@name"
+        @bot.irc.send "MONITOR + #{@name}"
       else
         refresh
-        @monitored_timer = Timer.new(@bot, interval: 30) {
+        @monitored_timer = Timer.new(@bot, interval: 30) do
           refresh
-        }
+        end
         @monitored_timer.start
       end
 
@@ -405,9 +407,9 @@ module Cinch
     # @see #monitor
     def unmonitor
       if @bot.irc.isupport["MONITOR"] > 0
-        @bot.irc.send "MONITOR - #@name"
+        @bot.irc.send "MONITOR - #{@name}"
       else
-        @monitored_timer.stop if @monitored_timer
+        @monitored_timer&.stop
       end
 
       @monitored = false
@@ -425,8 +427,7 @@ module Cinch
       dcc = DCC::Outgoing::Send.new(receiver: self,
                                     filename: filename,
                                     io: io,
-                                    own_ip: own_ip
-                                    )
+                                    own_ip: own_ip)
 
       dcc.start_server
 
@@ -435,6 +436,7 @@ module Cinch
                                         /\001DCC RESUME #{filename} #{dcc.port} (\d+)\001/,
                                         /$/)) do |m, position|
         next unless m.user == self
+
         dcc.seek(position.to_i)
         m.user.send "\001DCC ACCEPT #{filename} #{dcc.port} #{position}\001"
 
@@ -460,10 +462,11 @@ module Cinch
     # @return [void]
     # @api private
     def online=(bool)
-      notify = self.__send__("online?_unsynced") != bool && @monitored
+      notify = __send__("online?_unsynced") != bool && @monitored
       sync(:online?, bool, true)
 
       return unless notify
+
       if bool
         @bot.handlers.dispatch(:online, nil, self)
       else
@@ -477,7 +480,8 @@ module Cinch
     # @api private
     # @return [void]
     def update_nick(new_nick)
-      @last_nick, @name = @name, new_nick
+      @last_nick = @name
+      @name = new_nick
       # Unsync authname because some networks tie authentication to
       # the nick, so the user might not be authenticated anymore after
       # changing their nick

data/lib/cinch/user_list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "cinch/cached_list"
 
 module Cinch
@@ -22,7 +24,8 @@ module Cinch
     # @return [User]
     # @see Bot#User
     def find_ensured(*args)
-      user, host = nil, nil
+      user = nil
+      host = nil
       case args.size
       when 1
         nick = args.first
@@ -35,15 +38,11 @@ module Cinch
         raise ArgumentError
       end
 
-      if nick == @bot.nick
-        user_obj = @bot
-      end
+      user_obj = @bot if nick == @bot.nick
 
       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
+        user_obj = @cache[downcased_nick] ||= User.new(*bargs, @bot) if user_obj.nil?
         if user && host
           # Explicitly set user and host whenever we request a User
           # object to update them on e.g. JOIN.
@@ -59,9 +58,7 @@ module Cinch
     # @param [String] nick nick of a user
     # @return [User, nil]
     def find(nick)
-      if nick == @bot.nick
-        return @bot
-      end
+      return @bot if nick == @bot.nick
 
       downcased_nick = nick.irc_downcase(@bot.irc.isupport["CASEMAPPING"])
       @mutex.synchronize do
@@ -81,7 +78,7 @@ module Cinch
     # @api private
     # @return [void]
     def delete(user)
-      @cache.delete_if {|n, u| u == user }
+      @cache.delete_if { |_n, u| u == user }
     end
   end
 end