grinch 1.0.1 → 1.1.0

data/lib/cinch/channel_list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "cinch/cached_list"
 
 module Cinch

data/lib/cinch/configuration.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Cinch
   # @since 2.0.0
   class Configuration < OpenStruct
-    KnownOptions = []
+    KnownOptions = [].freeze
 
     # Generate a default configuration.
     #
@@ -21,14 +23,16 @@ module Cinch
     end
 
     def [](key)
-      # FIXME also adjust method_missing
+      # FIXME: also adjust method_missing
       raise ArgumentError, "Unknown option #{key}" unless self.class::KnownOptions.include?(key)
+
       @table[key]
     end
 
     def []=(key, value)
-      # FIXME also adjust method_missing
+      # FIXME: also adjust method_missing
       raise ArgumentError, "Unknown option #{key}" unless self.class::KnownOptions.include?(key)
+
       modifiable[new_ostruct_member(key)] = value
     end
 
@@ -42,9 +46,7 @@ module Cinch
     #   configuration.
     # @return [void]
     def load(new_config, from_default = false)
-      if from_default
-        @table = self.class.default_config
-      end
+      @table = self.class.default_config if from_default
 
       new_config.each do |option, value|
         if value.is_a?(Hash)

data/lib/cinch/configuration/bot.rb

@@ -1,46 +1,48 @@
+# frozen_string_literal: true
+
 require "cinch/configuration"
 
 module Cinch
   class Configuration
     # @since 2.0.0
     class Bot < Configuration
-      KnownOptions = [:server, :port, :ssl, :password, :nick, :nicks,
-                      :realname, :user, :messages_per_second, :server_queue_size,
-                      :strictness, :message_split_start, :message_split_end,
-                      :max_messages, :plugins, :channels, :encoding, :reconnect, :max_reconnect_delay,
-                      :local_host, :timeouts, :ping_interval, :delay_joins, :dcc, :shared, :sasl, :default_logger_level]
+      KnownOptions = %i[server port ssl password nick nicks
+                        realname user messages_per_second server_queue_size
+                        strictness message_split_start message_split_end
+                        max_messages plugins channels encoding reconnect max_reconnect_delay
+                        local_host timeouts ping_interval delay_joins dcc shared sasl default_logger_level].freeze
 
       # (see Configuration.default_config)
       def self.default_config
         {
-          :server => "localhost",
-          :port   => 6667,
-          :ssl    => Configuration::SSL.new,
-          :password => nil,
-          :nick   => "cinch",
-          :nicks  => nil,
-          :realname => "cinch",
-          :user => "cinch",
-          :modes => [],
-          :messages_per_second => nil,
-          :server_queue_size => nil,
-          :strictness => :forgiving,
-          :message_split_start => '... ',
-          :message_split_end   => ' ...',
-          :max_messages => nil,
-          :plugins => Configuration::Plugins.new,
-          :channels => [],
-          :encoding => :irc,
-          :reconnect => true,
-          :max_reconnect_delay => 300,
-          :local_host => nil,
-          :timeouts => Configuration::Timeouts.new,
-          :ping_interval => 120,
-          :delay_joins => 0,
-          :dcc => Configuration::DCC.new,
-          :sasl => Configuration::SASL.new,
-          :shared => {},
-          :default_logger_level => :debug
+          server: "localhost",
+          port: 6667,
+          ssl: Configuration::SSL.new,
+          password: nil,
+          nick: "cinch",
+          nicks: nil,
+          realname: "cinch",
+          user: "cinch",
+          modes: [],
+          messages_per_second: nil,
+          server_queue_size: nil,
+          strictness: :forgiving,
+          message_split_start: "... ",
+          message_split_end: " ...",
+          max_messages: nil,
+          plugins: Configuration::Plugins.new,
+          channels: [],
+          encoding: :irc,
+          reconnect: true,
+          max_reconnect_delay: 300,
+          local_host: nil,
+          timeouts: Configuration::Timeouts.new,
+          ping_interval: 120,
+          delay_joins: 0,
+          dcc: Configuration::DCC.new,
+          sasl: Configuration::SASL.new,
+          shared: {},
+          default_logger_level: :debug,
         }
       end
     end

data/lib/cinch/configuration/dcc.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 require "cinch/configuration"
 
 module Cinch
   class Configuration
     # @since 2.0.0
     class DCC < Configuration
-      KnownOptions = [:own_ip]
+      KnownOptions = [:own_ip].freeze
 
       def self.default_config
         {
-          :own_ip => nil,
+          own_ip: nil,
         }
       end
     end

data/lib/cinch/configuration/plugins.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 require "cinch/configuration"
 
 module Cinch
   class Configuration
     # @since 2.0.0
     class Plugins < Configuration
-      KnownOptions = [:plugins, :prefix, :suffix, :options]
+      KnownOptions = %i[plugins prefix suffix options].freeze
 
       def self.default_config
         {
-          :plugins => [],
-          :prefix  => /^!/,
-          :suffix  => nil,
-          :options => Hash.new {|h,k| h[k] = {}},
+          plugins: [],
+          prefix: /^!/,
+          suffix: nil,
+          options: Hash.new { |h, k| h[k] = {} },
         }
       end
 
@@ -20,7 +22,7 @@ module Cinch
         new_config.each do |option, value|
           case option
           when :plugins
-            _new_config[option] = value.map{|v| Cinch::Utilities::Kernel.string_to_const(v)}
+            _new_config[option] = value.map { |v| Cinch::Utilities::Kernel.string_to_const(v) }
           when :options
             _value = self[:options]
             value.each do |k, v|

data/lib/cinch/configuration/sasl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "cinch/configuration"
 require "cinch/sasl"
 
@@ -5,13 +7,13 @@ module Cinch
   class Configuration
     # @since 2.0.0
     class SASL < Configuration
-      KnownOptions = [:username, :password, :mechanisms]
+      KnownOptions = %i[username password mechanisms].freeze
 
       def self.default_config
         {
-          :username => nil,
-          :password => nil,
-          :mechanisms => [Cinch::SASL::DH_Blowfish, Cinch::SASL::Plain]
+          username: nil,
+          password: nil,
+          mechanisms: [Cinch::SASL::DH_Blowfish, Cinch::SASL::Plain],
         }
       end
     end

data/lib/cinch/configuration/ssl.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 require "cinch/configuration"
 
 module Cinch
   class Configuration
     # @since 2.0.0
     class SSL < Configuration
-      KnownOptions = [:use, :verify, :client_cert, :ca_path]
+      KnownOptions = %i[use verify client_cert ca_path].freeze
 
       def self.default_config
         {
-          :use => false,
-          :verify => false,
-          :client_cert => nil,
-          :ca_path => "/etc/ssl/certs",
+          use: false,
+          verify: false,
+          client_cert: nil,
+          ca_path: "/etc/ssl/certs",
         }
       end
     end

data/lib/cinch/configuration/timeouts.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 require "cinch/configuration"
 
 module Cinch
   class Configuration
     # @since 2.0.0
     class Timeouts < Configuration
-      KnownOptions = [:read, :connect]
+      KnownOptions = %i[read connect].freeze
 
       def self.default_config
-        {:read => 240, :connect => 10,}
+        { read: 240, connect: 10 }
       end
     end
   end

data/lib/cinch/constants.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cinch
   # All standard and some non-standard numeric replies used by the IRC
   # protocol.
@@ -274,7 +276,7 @@ module Cinch
     # revisions) and the <debuglevel> is used to indicate if the
     # server is running in "debug mode".
     #
-    #The "comments" field may contain any comments about the version or
+    # The "comments" field may contain any comments about the version or
     # further version details.
     RPL_VERSION  = 351
 

data/lib/cinch/dcc.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "cinch/dcc/outgoing"
 require "cinch/dcc/incoming"
 

data/lib/cinch/dcc/dccable_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cinch
   module DCC
     # This module describes the required interface for objects that should
@@ -12,26 +14,22 @@ module Cinch
       # @param [Integer] number Read `number` bytes at most
       # @return [String] The read data
       # @return [nil] If no more data can be read
-      def read(number)
-      end
+      def read(number); end
 
       # Seek to a specific position.
       #
       # @param [Integer] position The position in bytes to seek to
       # @return [void]
-      def seek(position)
-      end
+      def seek(position); end
 
       # @return [String] A string representing the object's path or name.
       #
       # @note This is only required if calling {User#dcc_send} with only
       #   one argument
-      def path
-      end
+      def path; end
 
       # @return [Integer] The total size of the data, in bytes.
-      def size
-      end
+      def size; end
     end
   end
 end

data/lib/cinch/dcc/incoming.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require "cinch/dcc/incoming/send"

data/lib/cinch/dcc/incoming/send.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "socket"
 require "ipaddr"
 
@@ -50,11 +52,11 @@ module Cinch
         PRIVATE_NETS = [IPAddr.new("fc00::/7"),
                         IPAddr.new("10.0.0.0/8"),
                         IPAddr.new("172.16.0.0/12"),
-                        IPAddr.new("192.168.0.0/16")]
+                        IPAddr.new("192.168.0.0/16")].freeze
 
         # @private
         LOCAL_NETS = [IPAddr.new("127.0.0.0/8"),
-                      IPAddr.new("::1/128")]
+                      IPAddr.new("::1/128")].freeze
 
         # @return [User]
         attr_reader :user
@@ -123,23 +125,23 @@ module Cinch
           end
 
           socket.close
-          return true
+          true
         rescue EOFError
-          return false
+          false
         end
 
         # @return [Boolean] True if the DCC originates from a private ip
         # @see #from_localhost?
         def from_private_ip?
-          ip   = IPAddr.new(@ip)
-          PRIVATE_NETS.any? {|n| n.include?(ip)}
+          ip = IPAddr.new(@ip)
+          PRIVATE_NETS.any? { |n| n.include?(ip) }
         end
 
         # @return [Boolean] True if the DCC originates from localhost
         # @see #from_private_ip?
         def from_localhost?
-          ip   = IPAddr.new(@ip)
-          LOCAL_NETS.any? {|n| n.include?(ip)}
+          ip = IPAddr.new(@ip)
+          LOCAL_NETS.any? { |n| n.include?(ip) }
         end
       end
     end

data/lib/cinch/dcc/outgoing.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require "cinch/dcc/outgoing/send"

data/lib/cinch/dcc/outgoing/send.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "socket"
 require "ipaddr"
 require "timeout"
@@ -73,16 +75,14 @@ module Cinch
         # @return [void]
         # @note This method blocks.
         def listen
-          begin
-            fd = nil
-            Timeout.timeout(30) do
-              fd, _ = @socket.accept
-            end
-            send_data(fd)
-            fd.close
-          ensure
-            @socket.close
+          fd = nil
+          Timeout.timeout(30) do
+            fd, _ = @socket.accept
           end
+          send_data(fd)
+          fd.close
+        ensure
+          @socket.close
         end
 
         # Seek to `pos` in the data.
@@ -100,16 +100,15 @@ module Cinch
         end
 
         private
+
         def send_data(fd)
           @io.advise(:sequential)
 
           while chunk = @io.read(8096)
-            while true
+            loop do
               rs, ws = IO.select([fd], [fd])
-              if !rs.empty?
-                rs.first.recv(8096)
-              end
-              if !ws.empty?
+              rs.first.recv(8096) unless rs.empty?
+              unless ws.empty?
                 ws.first.write(chunk)
                 break
               end

data/lib/cinch/exceptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cinch
   # A collection of exceptions.
   module Exceptions

data/lib/cinch/formatting.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cinch
   # This module can be used for adding and removing colors and
   # formatting to/from messages.
@@ -41,34 +43,34 @@ module Cinch
   module Formatting
     # @private
     Colors = {
-      :white  => "00",
-      :black  => "01",
-      :blue   => "02",
-      :green  => "03",
-      :red    => "04",
-      :brown  => "05",
-      :purple => "06",
-      :orange => "07",
-      :yellow => "08",
-      :lime   => "09",
-      :teal   => "10",
-      :aqua   => "11",
-      :royal  => "12",
-      :pink   => "13",
-      :grey   => "14",
-      :silver => "15",
-    }
+      white: "00",
+      black: "01",
+      blue: "02",
+      green: "03",
+      red: "04",
+      brown: "05",
+      purple: "06",
+      orange: "07",
+      yellow: "08",
+      lime: "09",
+      teal: "10",
+      aqua: "11",
+      royal: "12",
+      pink: "13",
+      grey: "14",
+      silver: "15",
+    }.freeze
 
     # @private
     Attributes = {
-      :bold       => 2.chr,
-      :underlined => 31.chr,
-      :underline  => 31.chr,
-      :reversed   => 22.chr,
-      :reverse    => 22.chr,
-      :italic     => 29.chr,
-      :reset      => 15.chr,
-    }
+      bold: 2.chr,
+      underlined: 31.chr,
+      underline: 31.chr,
+      reversed: 22.chr,
+      reverse: 22.chr,
+      italic: 29.chr,
+      reset: 15.chr,
+    }.freeze
 
     # @param [Array<Symbol>] settings The colors and attributes to apply.
     #   When supplying two colors, the first will be used for the
@@ -82,10 +84,10 @@ module Cinch
     # @example Nested formatting, combining text styles and colors
     #   reply = Format(:underline, "Hello %s! Is your favourite color %s?" % [Format(:bold, "stranger"), Format(:red, "red")])
     def self.format(*settings, string)
-      string   = string.dup
+      string = string.dup
 
-      attributes = settings.select {|k| Attributes.has_key?(k)}.map {|k| Attributes[k]}
-      colors = settings.select {|k| Colors.has_key?(k)}.map {|k| Colors[k]}
+      attributes = settings.select { |k| Attributes.key?(k) }.map { |k| Attributes[k] }
+      colors = settings.select { |k| Colors.key?(k) }.map { |k| Colors[k] }
       if colors.size > 2
         raise ArgumentError, "At most two colors (foreground and background) might be specified"
       end
@@ -108,7 +110,7 @@ module Cinch
       # Replace the reset code of nested strings to continue the
       # formattings of the outer string.
       string.gsub!(/#{Attributes[:reset]}/, Attributes[:reset] + prepend)
-      return prepend + string + append
+      prepend + string + append
     end
 
     # Deletes all mIRC formatting codes from the string. This strips
@@ -119,7 +121,7 @@ module Cinch
     # @return [String] The filtered string
     # @since 2.2.0
     def self.unformat(string)
-      string.gsub(/[\x02\x0f\x16\x1d\x1f\x12]|\x03(\d{1,2}(,\d{1,2})?)?/, '')
+      string.gsub(/[\x02\x0f\x16\x1d\x1f\x12]|\x03(\d{1,2}(,\d{1,2})?)?/, "")
     end
   end
 end