cinch 2.0.0.pre.1 → 2.0.0.pre.2

data/docs/bot_options.md

@@ -1,4 +1,5 @@
 # @title Bot options
+# @markup kramdown
 
 # Options
 Note: This page describes options of Cinch. It does not describe how

data/docs/changes.md

@@ -1,37 +1,30 @@
 # @title What has changed?
+# @markup kramdown
 
 # What has changed in 2.0?
-1. **Added support for SASL**
-1. **Added support for DCC SEND**
-1. **Added a fair scheduler for outgoing messages**
-1. **Added required plugin options**
-1. **Added support for colors/formatting**
-1. **Added network discovery**
-1. **Added match groups**
-1. **Added match options overwriting plugin options**
-1. **Added support for actions (/me)**
-1. **Added support for broken IRC networks**
-1. **Dynamic timers**
-1. **Reworked logging facilities**
-
-1. **API improvements**
-   1. **Helper changes**
-   1. **Added a Cinch::Target Target class**
-   1. **Cinch::Constants**
-   1. **New methods**
-      1. **Cinch::Bot**
-      1. **Cinch::Channel**
-      1. **Cinch::Helpers**
-      1. **Cinch::IRC**
-      1. **Cinch::Message**
-      1. **Cinch::User**
-   1. **Removed/Renamed methods**
-   1. **Handlers**
+1. Added support for SASL
+1. Added support for DCC SEND
+1. Added a fair scheduler for outgoing messages
+1. Added required plugin options
+1. Added support for colors/formatting
+1. Added network discovery
+1. Added match groups
+1. Added match options overwriting plugin options
+1. Added support for actions (/me)
+1. Added support for broken IRC networks
+1. Dynamic timers
+1. Reworked logging facilities
+1. API improvements
+   1. Helper changes
+   1. Added a Cinch::Target Target class
+   1. Cinch::Constants
+   1. New methods
+   1. Removed/Renamed methods
+   1. Handlers
    1. The Plugin class
-   1. **Channel/Target/User implement Comparable**
-   1. **Renamed `*Manager` to `*List`**
-
-1. **New events**
+   1. Channel/Target/User implement Comparable
+   1. Renamed `*Manager` to `*List`
+1. New events
 
 ## Added support for SASL
 
@@ -141,7 +134,7 @@ Example:
 
 ## Added match options overwriting plugin options
 
-Matchers now have their own `:prefix`, `:suffix` and `:reacting_on`
+Matchers now have their own `:prefix`, `:suffix` and `:react_on`
 options which overwrite plugin options for single matchers.
 
 
@@ -150,7 +143,7 @@ options which overwrite plugin options for single matchers.
 A new event, {`:action`} has been added and can be used for matching
 actions as follows:
 
-    match "kicks the bot", reacting_on: :action
+    match "kicks the bot", react_on: :action
     def execute(m)
       m.reply "Ouch!"
     end

data/docs/common_mistakes.md

@@ -1,4 +1,5 @@
 # @title Common mistakes
+# @markup kramdown
 
 # I defined an initialize method in my plugin and now it doesn't work properly anymore
 

data/docs/common_tasks.md

@@ -1,4 +1,5 @@
 # @title Common Tasks
+# @markup kramdown
 
 # Checking if a user is online
 

data/docs/encodings.md

@@ -1,4 +1,6 @@
 # @title Encodings
+# @markup kramdown
+
 # Encodings
 
 The IRC protocol doesn't define a specific encoding that should be

data/docs/events.md

@@ -1,4 +1,5 @@
 # @title Events
+# @markup kramdown
 
 Cinch provides three kinds of events:
 

data/docs/logging.md

@@ -1,4 +1,5 @@
 # @title Logging
+# @markup kramdown
 
 TODO explain the logging facilities
 

data/docs/migrating.md

@@ -1,4 +1,6 @@
 # @title Migration Guide
+# @markup kramdown
+
 # Migration Guide
 
 This document explains how to migrate between API incompatible
@@ -36,9 +38,8 @@ shouldn't and usually mustn't overwrite:
 - `::plugin_name`
 - `::prefix=`
 - `::prefix`
+- `::react_on=`
 - `::react_on`
-- `::reacting_on=`
-- `::reacting_on`
 - `::required_options=`
 - `::required_options`
 - `::set`

data/docs/readme.md

@@ -1,18 +1,19 @@
 # @title README
+# @markup kramdown
 
 
-- {file:changes.md Changelog}
-- {file:migrating.md Migration guides}
+- {file:docs/changes.md Changelog}
+- {file:docs/migrating.md Migration guides}
 
 # Important documents
 
 The following is a list of important documents to read.
 
-- {file:bot_options.md Bot options}
-- {file:common_tasks.md Common Tasks}
-- {file:common_mistakes.md Common mistakes}
+- {file:docs/bot_options.md Bot options}
+- {file:docs/common_tasks.md Common Tasks}
+- {file:docs/common_mistakes.md Common mistakes}
 - {Cinch::DCC DCC}
-- {file:encodings.md Encodings}
-- {file:logging.md Logging}
+- {file:docs/encodings.md Encodings}
+- {file:docs/logging.md Logging}
 - {Cinch::SASL SASL}
-- {file:events.d Events}
+- {file:docs/events.md Events}

data/lib/cinch/channel.rb

@@ -17,7 +17,7 @@ module Cinch
     # Users are represented by a Hash, mapping individual users to an
     # array of modes (e.g. "o" for opped).
     #
-    # @return [Hash<User => Array<String>>] all users in the channel
+    # @return [Hash{User => Array<String}>] all users in the channel
     # @version 1.1.0
     attr_reader :users
     synced_attr_reader :users
@@ -40,7 +40,7 @@ module Cinch
     # either a value in the case of modes that take an option (e.g.
     # "k" for the channel key) or true.
     #
-    # @return [Hash<String => Object>]
+    # @return [Hash{String => Object}]
     attr_reader :modes
     synced_attr_reader :modes
     def initialize(name, bot)
@@ -139,7 +139,7 @@ module Cinch
     end
     # @endgroup
 
-    # @return [Number] The maximum number of allowed users in the
+    # @return [Integer] The maximum number of allowed users in the
     #   channel. 0 if unlimited.
     def limit
       @modes["l"].to_i

data/lib/cinch/dcc/dccable_object.rb

@@ -9,7 +9,7 @@ module Cinch
     module DCCableObject
       # Return the next `number` bytes of the object.
       #
-      # @param [Number] number Read `number` bytes at most
+      # @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)
@@ -17,7 +17,7 @@ module Cinch
 
       # Seek to a specific position.
       #
-      # @param [Number] position The position in bytes to seek to
+      # @param [Integer] position The position in bytes to seek to
       # @return [void]
       def seek(position)
       end
@@ -29,7 +29,7 @@ module Cinch
       def path
       end
 
-      # @return [Number] The total size of the data, in bytes.
+      # @return [Integer] The total size of the data, in bytes.
       def size
       end
     end

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

@@ -60,21 +60,21 @@ module Cinch
         # @return [String]
         attr_reader :filename
 
-        # @return [Number]
+        # @return [Integer]
         attr_reader :size
 
         # @return [String]
         attr_reader :ip
 
-        # @return [Number]
+        # @return [Fixnum]
         attr_reader :port
 
         # @param [Hash] opts
         # @option opts [User] user
         # @option opts [String] filename
-        # @option opts [Number] size
+        # @option opts [Integer] size
         # @option opts [String] ip
-        # @option opts [Number] port
+        # @option opts [Fixnum] port
         # @api private
         def initialize(opts)
           @user, @filename, @size, @ip, @port = opts.values_at(:user, :filename, :size, :ip, :port)

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

@@ -87,14 +87,14 @@ module Cinch
 
         # Seek to `pos` in the data.
         #
-        # @param [Number] pos
+        # @param [Integer] pos
         # @return [void]
         # @api private
         def seek(pos)
           @io.seek(pos)
         end
 
-        # @return [Number] The port used for the socket
+        # @return [Fixnum] The port used for the socket
         def port
           @port ||= @socket.addr[1]
         end

data/lib/cinch/helpers.rb

@@ -72,13 +72,13 @@ module Cinch
     #     Timer(5) { puts "timer fired" }
     #   end
     #
-    # @param [Number] interval Interval in seconds
+    # @param [Numeric] interval Interval in seconds
     # @param [Proc] block A proc to execute
     # @option options [Symbol] :method (:timer) Method to call (only
     #   if no proc is provided)
     # @option options [Boolean] :threaded (true) Call method in a
     #   thread?
-    # @option options [Number] :shots (Float::INFINITY) How often
+    # @option options [Integer] :shots (Float::INFINITY) How often
     #   should the timer fire?
     # @option options [Boolean] :start_automatically (true) If true,
     #   the timer will automatically start after the bot finished

data/lib/cinch/logger/zcbot_logger.rb

@@ -1,4 +1,4 @@
-require "cinch/logger/logger"
+require "cinch/logger"
 module Cinch
   class Logger
     # This logger logs all incoming messages in the format of zcbot.

data/lib/cinch/logger.rb

@@ -101,10 +101,10 @@ module Cinch
     # Logs a message.
     #
     # @param [String, Array] messages The message(s) to log
-    # @param [Symbol<:debug, :incoming, :outgoing, :info, :warn,
-    #   :exception, :error, :fatal>] event The kind of event that
+    # @param [:debug, :incoming, :outgoing, :info, :warn,
+    #   :exception, :error, :fatal] event The kind of event that
     #   triggered the message
-    # @param [Symbol<:debug, :info, :warn, :error, :fatal>] level The level of the message
+    # @param [:debug, :info, :warn, :error, :fatal] level The level of the message
     # @return [void]
     # @version 2.0.0
     def log(messages, event = :debug, level = event)
@@ -120,7 +120,7 @@ module Cinch
       end
     end
 
-    # @param [Symbol<:debug, :info, :warn, :error, :fatal>] level
+    # @param [:debug, :info, :warn, :error, :fatal] level
     # @return [Boolean] Whether the currently set logging level will
     #   allow the passed in level to be logged
     # @since 2.0.0

data/lib/cinch/message.rb

@@ -93,7 +93,7 @@ module Cinch
       @server ||= @prefix[/^(\S+)/, 1]
     end
 
-    # @return [Number, nil] the numeric error code, if any
+    # @return [Integer, nil] the numeric error code, if any
     def error
       @error ||= (command.to_i if numeric_reply? && command[/[45]\d\d/])
     end

data/lib/cinch/mode_parser.rb

@@ -4,7 +4,7 @@ module Cinch
   module ModeParser
     # @param [String] modes The mode string as sent by the server
     # @param [Array<String>] params Parameters belonging to the modes
-    # @param [Hash<:add => Array<String>, :remove => Array<String>] param_modes
+    # @param [Hash{:add, :remove => Array<String>}] param_modes
     #   A mapping describing which modes require parameters
     def self.parse_modes(modes, params, param_modes = {})
       if modes.size == 0

data/lib/cinch/network.rb

@@ -79,7 +79,7 @@ module Cinch
     # value for when no network/ircd was detected so that MessageQueue
     # doesn't break.
 
-    # @return [Number] The `messages per second` value that best suits
+    # @return [Numeric] The `messages per second` value that best suits
     #   the current network
     def default_messages_per_second
       case @network
@@ -90,7 +90,7 @@ module Cinch
       end
     end
 
-    # @return [Number] The `server queue size` value that best suits
+    # @return [Integer] The `server queue size` value that best suits
     #   the current network
     def default_server_queue_size
       case @network

data/lib/cinch/plugin.rb

@@ -24,11 +24,11 @@ module Cinch
     #
     # @attr plugin_name
     module ClassMethods
-      # @return [Hash<Symbol<:pre, :post> => Array<Hook>>] All hooks
+      # @return [Hash{:pre, :post => Array<Hook>}] All hooks
       attr_reader :hooks
 
-      # @return [Array<Symbol<:message, :channel, :private>>] The list of events to react on
-      attr_accessor :reacting_on
+      # @return [Array<:message, :channel, :private>] The list of events to react on
+      attr_accessor :react_on
 
       # The name of the plugin.
       # @overload plugin_name
@@ -79,7 +79,7 @@ module Cinch
       # @attr [Boolean] use_suffix
       # @attr [Symbol] method
       # @attr [Symbol] group
-      Matcher = Struct.new(:pattern, :use_prefix, :use_suffix, :method, :group, :prefix, :suffix, :reacting_on)
+      Matcher = Struct.new(:pattern, :use_prefix, :use_suffix, :method, :group, :prefix, :suffix, :react_on)
 
       # Represents a Listener as created by {#listen_to}.
       #
@@ -94,7 +94,7 @@ module Cinch
       #   timers. This class only describes a Timer that still has to
       #   be created.
       #
-      # @attr [Number] interval
+      # @attr [Numeric] interval
       # @attr [Symbol] method
       # @attr [Hash] options
       # @attr [Boolean] registered
@@ -118,7 +118,7 @@ module Cinch
           @hooks            = Hash.new{|h, k| h[k] = []}
           @prefix           = nil
           @suffix           = nil
-          @reacting_on      = :message
+          @react_on         = :message
           @required_options = []
           self.plugin_name  = nil
         end
@@ -131,7 +131,7 @@ module Cinch
       #   - {#help}
       #   - {#plugin_name}
       #   - {#prefix}
-      #   - {#reacting_on}
+      #   - {#react_on}
       #   - {#required_options}
       #   - {#suffix}
       #
@@ -140,7 +140,7 @@ module Cinch
       #   @param [Object] value
       #   @return [void]
       # @overload set(options)
-      #   @param [Hash<Symbol => Object>] options The options, as key => value associations
+      #   @param [Hash{Symbol => Object}] options The options, as key => value associations
       #   @return [void]
       #   @example
       #     set(:help   => "the help message",
@@ -177,8 +177,8 @@ module Cinch
       # @todo Document match/listener grouping
       # @todo document new options
       def match(pattern, options = {})
-        options = {:use_prefix => true, :use_suffix => true, :method => :execute, :group => nil, :prefix => nil, :suffix => nil, :reacting_on => nil}.merge(options)
-        matcher = Matcher.new(pattern, *options.values_at(:use_prefix, :use_suffix, :method, :group, :prefix, :suffix, :reacting_on))
+        options = {:use_prefix => true, :use_suffix => true, :method => :execute, :group => nil, :prefix => nil, :suffix => nil, :react_on => nil}.merge(options)
+        matcher = Matcher.new(pattern, *options.values_at(:use_prefix, :use_suffix, :method, :group, :prefix, :suffix, :react_on))
         @matchers << matcher
 
         matcher
@@ -200,7 +200,7 @@ module Cinch
       #   @param [Hash] options
       #   @option options [Symbol] :method (:listen) The method to
       #     execute
-      #   @return [Array<Listener]
+      #   @return [Array<Listener>]
       def listen_to(*types)
         options = {:method => :listen}
         if types.last.is_a?(Hash)
@@ -218,23 +218,16 @@ module Cinch
         @ctcps << command.to_s.upcase
       end
 
-      # Set which kind of messages to react on for matchers.
-      # @param [Symbol<:message, :channel, :private>] event Which event to react on
-      # @return [void]
-      def react_on(event)
-        self.reacting_on = event
-      end
-
       # @example
       #   timer 5, method: :some_method
       #   def some_method
       #     Channel("#cinch-bots").send(Time.now.to_s)
       #   end
       #
-      # @param [Number] interval Interval in seconds
+      # @param [Numeric] interval Interval in seconds
       # @option options [Symbol] :method (:timer) Method to call (only
       #   if no proc is provided)
-      # @option options [Number] :shots (Float::INFINITY) How often
+      # @option options [Integer] :shots (Float::INFINITY) How often
       #   should the timer fire?
       # @option options [Boolean] :threaded (true) Call method in a
       #   thread?
@@ -256,7 +249,7 @@ module Cinch
       # Defines a hook which will be run before or after a handler is
       # executed, depending on the value of `type`.
       #
-      # @param [Symbol<:pre, :post>] type Run the hook before or after
+      # @param [:pre, :post] type Run the hook before or after
       #   a handler?
       # @option options [Array<:match, :listen_to, :ctcp>] :for ([:match, :listen_to, :ctcp])
       #   Which kinds of events to run the hook for.
@@ -369,7 +362,7 @@ module Cinch
         _suffix = matcher.use_suffix ? matcher.suffix || suffix : nil
 
         pattern_to_register = Pattern.new(_prefix, matcher.pattern, _suffix)
-        react_on = matcher.reacting_on || self.class.reacting_on || :message
+        react_on = matcher.react_on || self.class.react_on || :message
 
         @bot.loggers.debug "[plugin] #{self.class.plugin_name}: Registering executor with pattern `#{pattern_to_register.inspect}`, reacting on `#{react_on}`"
 

data/lib/cinch/rubyext/string.rb

@@ -2,7 +2,7 @@
 class String
   # Like `String#downcase`, but respecting different IRC casemaps.
   #
-  # @param [Symbol<:rfc1459, :strict-rfc1459, :ascii>] mapping
+  # @param [:rfc1459, :"strict-rfc1459", :ascii] mapping
   # @return [String]
   def irc_downcase(mapping)
     case mapping
@@ -18,7 +18,7 @@ class String
 
   # Like `String#upcase`, but respecting different IRC casemaps.
   #
-  # @param [Symbol<:rfc1459, :strict-rfc1459, :ascii>] mapping
+  # @param [:rfc1459, :"strict-rfc1459", :ascii] mapping
   # @return [String]
   def irc_upcase(mapping)
     case mapping

data/lib/cinch/sasl/dh_blowfish.rb

@@ -15,7 +15,7 @@ module Cinch
           "DH-BLOWFISH"
         end
 
-        # @return [Array<Number, Number, Number>] p, g and y for DH
+        # @return [Array(Numeric, Numeric, Numeric)] p, g and y for DH
         def unpack_payload(payload)
           pgy     = []
           payload = payload.dup

data/lib/cinch/timer.rb

@@ -24,7 +24,7 @@ module Cinch
     # @return [Bot]
     attr_reader :bot
 
-    # @return [Number] The interval (in seconds) of the timer
+    # @return [Numeric] The interval (in seconds) of the timer
     attr_accessor :interval
 
     # @return [Boolean] If true, each invocation will be
@@ -37,7 +37,7 @@ module Cinch
     # @return [Boolean]
     attr_reader :started
 
-    # @return [Number] The remaining number of shots before this timer
+    # @return [Integer] The remaining number of shots before this timer
     #   will stop. This value will automatically reset after
     #   restarting the timer.
     attr_accessor :shots
@@ -50,9 +50,9 @@ module Cinch
 
     # @param [Bot] bot The instance of {Bot} the timer is associated
     #   with
-    # @option options [Number] :interval The interval (in seconds) of
+    # @option options [Numeric] :interval The interval (in seconds) of
     #   the timer
-    # @option options [Number] :shots (Float::INFINITY) How often should the
+    # @option options [Integer] :shots (Float::INFINITY) How often should the
     #   timer fire?
     # @option options [Boolean] :threaded (true) If true, each invocation will be
     #   executed in a thread of its own.

data/lib/cinch/user.rb

@@ -7,7 +7,7 @@ module Cinch
   # @attr_reader [String] host
   # @attr_reader [String] realname
   # @attr_reader [String] authname
-  # @attr_reader [Number] idle How long this user has been idle, in seconds.
+  # @attr_reader [Integer] idle How long this user has been idle, in seconds.
   #   This is a snapshot of the last WHOIS.
   # @attr_reader [Time] signed_on_at
   # @attr_reader [Array<Channel>] channels All channels the user is in.

data/lib/cinch/version.rb

@@ -1,4 +1,4 @@
 module Cinch
   # Version of the library
-  VERSION = '2.0.0-pre.1'
+  VERSION = '2.0.0-pre.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cinch
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.1
+  version: 2.0.0.pre.2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-03 00:00:00.000000000 Z
+date: 2012-03-05 00:00:00.000000000 Z
 dependencies: []
 description: A simple, friendly DSL for creating IRC bots
 email: