grinch 1.0.1 → 1.1.0

data/lib/cinch/network.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cinch
   # This class allows querying the IRC network for its name and used
   # server software as well as certain non-standard behaviour.

data/lib/cinch/open_ended_queue.rb

@@ -1,4 +1,4 @@
-require "thread"
+# frozen_string_literal: true
 
 # Like Ruby's Queue class, but allowing both pushing and unshifting
 # objects.
@@ -9,17 +9,17 @@ class OpenEndedQueue < Queue
   # @return [void]
   def unshift(obj)
     t = nil
-    @mutex.synchronize{
+    @mutex.synchronize do
       @que.unshift obj
       begin
         t = @waiting.shift
-        t.wakeup if t
+        t&.wakeup
       rescue ThreadError
         retry
       end
-    }
+    end
     begin
-      t.run if t
+      t&.run
     rescue ThreadError
     end
   end

data/lib/cinch/pattern.rb

@@ -1,4 +1,5 @@
-# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
 module Cinch
   # @api private
   # @since 1.1.0
@@ -9,25 +10,25 @@ module Cinch
     def self.obj_to_r(obj, anchor = nil)
       case obj
       when Regexp, NilClass
-        return obj
+        obj
       else
         escaped = Regexp.escape(obj.to_s)
         case anchor
         when :start
-          return Regexp.new("^" + escaped)
+          Regexp.new("^" + escaped)
         when :end
-          return Regexp.new(escaped + "$")
+          Regexp.new(escaped + "$")
         when nil
-          return Regexp.new(Regexp.escape(obj.to_s))
+          Regexp.new(Regexp.escape(obj.to_s))
         end
       end
     end
 
     def self.resolve_proc(obj, msg = nil)
       if obj.is_a?(Proc)
-        return resolve_proc(obj.call(msg), msg)
+        resolve_proc(obj.call(msg), msg)
       else
-        return obj
+        obj
       end
     end
 
@@ -44,7 +45,9 @@ module Cinch
     attr_reader :suffix
     attr_reader :pattern
     def initialize(prefix, pattern, suffix)
-      @prefix, @pattern, @suffix = prefix, pattern, suffix
+      @prefix = prefix
+      @pattern = pattern
+      @suffix = suffix
     end
 
     def to_r(msg = nil)

data/lib/cinch/plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "cinch/helpers"
 
 module Cinch
@@ -42,11 +44,11 @@ module Cinch
 
       # @return [String]
       def plugin_name=(new_name)
-        if new_name.nil? && self.name
-          @plugin_name = self.name.split("::").last.downcase
-        else
-          @plugin_name = new_name
-        end
+        @plugin_name = if new_name.nil? && name
+                         name.split("::").last.downcase
+                       else
+                         new_name
+                       end
       end
 
       # @return [Array<Matcher>] All matchers
@@ -124,7 +126,7 @@ module Cinch
           @listeners        = []
           @timers           = []
           @help             = nil
-          @hooks            = Hash.new{|h, k| h[k] = []}
+          @hooks            = Hash.new { |h, k| h[k] = [] }
           @prefix           = nil
           @suffix           = nil
           @react_on         = :message
@@ -161,13 +163,13 @@ module Cinch
         when 1
           # {:key => value, ...}
           args.first.each do |key, value|
-            self.send("#{key}=", value)
+            send("#{key}=", value)
           end
         when 2
           # key, value
-          self.send("#{args.first}=", args.last)
+          send("#{args.first}=", args.last)
         else
-          raise ArgumentError # TODO proper error message
+          raise ArgumentError # TODO: proper error message
         end
       end
 
@@ -194,18 +196,16 @@ module Cinch
       # @todo Document match/listener grouping
       def match(pattern, options = {})
         options = {
-          :use_prefix => true,
-          :use_suffix => true,
-          :method => :execute,
-          :group => nil,
-          :prefix => nil,
-          :suffix => nil,
-          :react_on => nil,
-          :strip_colors => false,
+          use_prefix: true,
+          use_suffix: true,
+          method: :execute,
+          group: nil,
+          prefix: nil,
+          suffix: nil,
+          react_on: nil,
+          strip_colors: false,
         }.merge(options)
-        if options[:react_on]
-          options[:react_on] = options[:react_on].to_s.to_sym
-        end
+        options[:react_on] = options[:react_on].to_s.to_sym if options[:react_on]
         matcher = Matcher.new(pattern, *options.values_at(:use_prefix,
                                                           :use_suffix,
                                                           :method,
@@ -229,12 +229,10 @@ module Cinch
       #     execute
       #   @return [Array<Listener>]
       def listen_to(*types)
-        options = {:method => :listen}
-        if types.last.is_a?(Hash)
-          options.merge!(types.pop)
-        end
+        options = { method: :listen }
+        options.merge!(types.pop) if types.last.is_a?(Hash)
 
-        listeners = types.map {|type| Listener.new(type.to_s.to_sym, options[:method])}
+        listeners = types.map { |type| Listener.new(type.to_s.to_sym, options[:method]) }
         @listeners.concat listeners
 
         listeners
@@ -266,7 +264,7 @@ module Cinch
       # @return [Timer]
       # @since 1.1.0
       def timer(interval, options = {})
-        options = {:method => :timer, :threaded => true}.merge(options)
+        options = { method: :timer, threaded: true }.merge(options)
         timer = Timer.new(interval, options, false)
         @timers << timer
 
@@ -287,7 +285,7 @@ module Cinch
       # @return [Hook]
       # @since 1.1.0
       def hook(type, options = {})
-        options = {:for => [:match, :listen_to, :ctcp], :method => :hook, :group => nil}.merge(options)
+        options = { for: %i[match listen_to ctcp], method: :hook, group: nil }.merge(options)
         hook = Hook.new(type, options[:for], options[:method], options[:group])
         __hooks(type) << hook
 
@@ -297,36 +295,34 @@ module Cinch
       # @return [Hash]
       # @api private
       def __hooks(type = nil, events = nil, group = nil)
-        if type.nil?
-          hooks = @hooks
-        else
-          hooks = @hooks[type]
-        end
+        hooks = if type.nil?
+                  @hooks
+                else
+                  @hooks[type]
+                end
 
         if events.nil?
           return hooks
         else
           events = [*events]
-          if hooks.is_a?(Hash)
-            hooks = hooks.map { |k, v| v }
-          end
-          hooks = hooks.select { |hook| (events & hook.for).size > 0 }
+          hooks = hooks.map { |_k, v| v } if hooks.is_a?(Hash)
+          hooks = hooks.reject { |hook| (events & hook.for).empty? }
         end
 
-        return hooks.select { |hook| hook.group.nil? || hook.group == group }
+        hooks.select { |hook| hook.group.nil? || hook.group == group }
       end
 
       # @return [Boolean] True if processing should continue
       # @api private
       def call_hooks(type, event, group, instance, args)
-        stop = __hooks(type, event, group).find { |hook|
+        stop = __hooks(type, event, group).find do |hook|
           # stop after the first hook that returns false
           if hook.method.respond_to?(:call)
             instance.instance_exec(*args, &hook.method) == false
           else
             instance.__send__(hook.method, *args) == false
           end
-        }
+        end
 
         !stop
       end
@@ -336,9 +332,9 @@ module Cinch
       # @since 2.0.0
       # @api private
       def check_for_missing_options(bot)
-        @required_options.select { |option|
-          !bot.config.plugins.options[self].has_key?(option)
-        }
+        @required_options.reject do |option|
+          bot.config.plugins.options[self].key?(option)
+        end
       end
     end
 
@@ -379,13 +375,13 @@ module Cinch
     private :__register_ctcps
 
     def __register_timers
-      @timers = self.class.timers.map {|timer_struct|
+      @timers = self.class.timers.map do |timer_struct|
         @bot.loggers.debug "[plugin] #{self.class.plugin_name}: Registering timer with interval `#{timer_struct.interval}` for method `#{timer_struct.options[:method]}`"
 
-        block = self.method(timer_struct.options[:method])
+        block = method(timer_struct.options[:method])
         options = timer_struct.options.merge(interval: timer_struct.interval)
         Cinch::Timer.new(@bot, options, &block)
-      }
+      end
     end
     private :__register_timers
 
@@ -479,9 +475,7 @@ module Cinch
     # @since 2.0.0
     def unregister
       @bot.loggers.debug "[plugin] #{self.class.plugin_name}: Unloading plugin"
-      @timers.each do |timer|
-        timer.stop
-      end
+      @timers.each(&:stop)
 
       handlers.each do |handler|
         handler.stop
@@ -512,4 +506,4 @@ module Cinch
   end
 end
 
-# TODO more details in "message dropped" debug output
+# TODO: more details in "message dropped" debug output

data/lib/cinch/plugin_list.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Cinch
   # @since 2.0.0
   class PluginList < Array
     def initialize(bot)
-      @bot     = bot
+      @bot = bot
       super()
     end
 
@@ -24,9 +26,7 @@ module Cinch
 
     # @since 2.0.0
     def unregister_plugins(plugins)
-      if plugins == self
-        plugins = self.dup
-      end
+      plugins = dup if plugins == self
       plugins.each { |plugin| unregister_plugin(plugin) }
     end
 

data/lib/cinch/rubyext/float.rb

@@ -1,3 +1,3 @@
-unless Float.const_defined?(:INFINITY)
-  Float::INFINITY = 1.0/0.0
-end
+# frozen_string_literal: true
+
+Float::INFINITY = 1.0 / 0.0 unless Float.const_defined?(:INFINITY)

data/lib/cinch/rubyext/module.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Extensions to Ruby's Module class.
 class Module
   # Like `attr_reader`, but for defining a synchronized attribute

data/lib/cinch/rubyext/string.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Extensions to Ruby's String class.
 class String
   # Like `String#downcase`, but respecting different IRC casemaps.
@@ -7,12 +9,12 @@ class String
   def irc_downcase(mapping)
     case mapping
     when :rfc1459
-      self.tr("A-Z[]\\\\^", "a-z{}|~")
+      tr("A-Z[]\\\\^", "a-z{}|~")
     when :"strict-rfc1459"
-      self.tr("A-Z[]\\\\", "a-z{}|")
+      tr("A-Z[]\\\\", "a-z{}|")
     else
       # when :ascii or unknown/nil
-      self.tr("A-Z", "a-z")
+      tr("A-Z", "a-z")
     end
   end
 
@@ -23,11 +25,11 @@ class String
   def irc_upcase(mapping)
     case mapping
     when :ascii
-      self.tr("a-z", "A-Z")
+      tr("a-z", "A-Z")
     when :rfc1459
-      self.tr("a-z{}|~", "A-Z[]\\\\^")
+      tr("a-z{}|~", "A-Z[]\\\\^")
     when :"strict-rfc1459"
-      self.tr("a-z{}|", "A-Z[]\\\\")
+      tr("a-z{}|", "A-Z[]\\\\")
     end
   end
 end

data/lib/cinch/sasl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "cinch/sasl/diffie_hellman"
 require "cinch/sasl/plain"
 require "cinch/sasl/dh_blowfish"

data/lib/cinch/sasl/dh_blowfish.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "openssl"
 require "base64"
 require "cinch/sasl/mechanism"
@@ -21,13 +23,13 @@ module Cinch
           payload = payload.dup
 
           3.times do
-            size = payload.unpack("n").first
+            size = payload.unpack1("n")
             payload.slice!(0, 2)
-            pgy << payload.unpack("a#{size}").first
+            pgy << payload.unpack1("a#{size}")
             payload.slice!(0, size)
           end
 
-          pgy.map {|i| OpenSSL::BN.new(i, 2).to_i}
+          pgy.map { |i| OpenSSL::BN.new(i, 2).to_i }
         end
 
         # @param [String] user

data/lib/cinch/sasl/diffie_hellman.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cinch
   module SASL
     class DiffieHellman
@@ -24,13 +26,14 @@ module Cinch
       end
 
       private
+
       # validate a public key
       def valid?
-        @e && @e.between?(2, @p - 2) && bits_set(@e) > 1
+        @e&.between?(2, @p - 2) && bits_set(@e) > 1
       end
 
       def bits_set(e)
-        ("%b" % e).count('1')
+        ("%b" % e).count("1")
       end
 
       def mod_exp(b, e, m)
@@ -40,7 +43,7 @@ module Cinch
           e = e >> 1
           b = (b * b) % m
         end
-        return result
+        result
       end
     end
   end

data/lib/cinch/sasl/mechanism.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cinch
   module SASL
     class Mechanism

data/lib/cinch/sasl/plain.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "base64"
 require "cinch/sasl/mechanism"
 

data/lib/cinch/syncable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cinch
   # Provide blocking access to user/channel information.
   module Syncable
@@ -8,17 +10,18 @@ module Cinch
     def wait_until_synced(attr)
       attr = attr.to_sym
       waited = 0
-      while true
+      loop do
         return if attribute_synced?(attr)
+
         waited += 1
 
         if waited % 100 == 0
-          bot.loggers.warn "A synced attribute ('%s' for %s) has not been available for %d seconds, still waiting" % [attr, self.inspect, waited / 10]
-          bot.loggers.warn caller.map {|s| "  #{s}"}
+          bot.loggers.warn "A synced attribute ('%s' for %s) has not been available for %d seconds, still waiting" % [attr, inspect, waited / 10]
+          bot.loggers.warn caller.map { |s| "  #{s}" }
 
           if waited / 10 >= 30
             bot.loggers.warn "  Giving up..."
-            raise Exceptions::SyncedAttributeNotAvailable, "'%s' for %s" % [attr, self.inspect]
+            raise Exceptions::SyncedAttributeNotAvailable, "'%s' for %s" % [attr, inspect]
           end
         end
         sleep 0.1
@@ -61,16 +64,14 @@ module Cinch
     # @api private
     def attr(attribute, data = false, unsync = false)
       unless unsync
-        if @when_requesting_synced_attribute
-          @when_requesting_synced_attribute.call(attribute)
-        end
+        @when_requesting_synced_attribute&.call(attribute)
         wait_until_synced(attribute)
       end
 
       if data
-        return @data[attribute]
+        @data[attribute]
       else
-        return instance_variable_get("@#{attribute}")
+        instance_variable_get("@#{attribute}")
       end
     end