cinch 0.2 → 0.2.3

data/README.rdoc

@@ -10,9 +10,6 @@ plugin, defining a rule, and watching your profits flourish.
 Cinch will do all of the hard work for you, so you can spend time creating cool plugins
 and extensions to wow your internet peers.
 
-Cinch is not a fully fledged IRC framework, its base is extremely small. If you're looking
-for a more controlled library check out {silverplatter-irc}[http://github.com/apeiros/silverplatter-irc].
-
 == Installation
 The latest version of Cinch is 0.2
 
@@ -102,9 +99,14 @@ could pass the 'nick' option to the hash.
    bot.join #{m.args[:channel]}
  end
 
+This method also works for arrays, to only reply to a message sent in the foo and bar channels
+
+ bot.plugin :hello, :channel => ['#foo', '#bar'] do |m|
+   m.reply "Hello"
+ end
+
 == Named Parameter Types
-Since version 0.2, Cinch supports named parameter types. Although at the moment you're constrained
-to the <i>digit</i>, <i>string</i> and <i>word</i> types. It means stuff like the this works:
+Since version 0.2, Cinch supports named parameter types. It means stuff like the this works:
 
  bot.plugin("say :n-digit :text") do |m|
    m.args[:n].to_i.times {
@@ -119,7 +121,24 @@ This would provide the following output on IRC
  Cinch> foo bar
  Cinch> foo bar
 
-* See Cinch::Base#compile for more information
+* See Cinch::Base#compile for more information and the available types
+
+Cinch also supports custom types. That's right, you can define you own type. Just like this:
+
+ bot.add_custom_type(:friends, "(injekt|lee|john|bob)")
+
+ bot.plugin("I like :friend-friends", :prefix => false) do |m|
+   m.reply "I like #{m.args[:friend]} too!"
+ end
+
+Which would provide the following output on IRC:
+
+ * Cinch has joined #cinch
+ injekt> I like spongebob
+ injekt> I like bob
+ Cinch> I like bob too!
+
+Note though that you must wrap your type regexp in capturing parenthesis and escape it yourself
 
 == Authors
 Just me at the moment, sad poor lonely me...

data/examples/custom_types.rb

@@ -0,0 +1,20 @@
+require 'cinch'
+
+bot = Cinch.setup do 
+  server "irc.freenode.org"
+  channels %w{ #cinch }
+end
+
+bot.add_custom_type(:friends, "(injekt|lee|john|bob)")
+bot.add_custom_type(:hex, "([\\dA-Fa-f]+?)")
+
+bot.plugin("I like :person-friends", :prefix => false) do |m|
+  m.reply "I like #{m.args[:person]} too!"
+end
+
+bot.plugin("checkhex :n-hex") do |m|
+  m.answer "Yes, #{m.args[:n]} is indeed hex."
+end
+
+bot.run
+

data/examples/seen.rb

@@ -23,7 +23,7 @@ bot.on :privmsg do |m|
   end
 end
 
-bot.plugin("seen :nick foo") do |m|
+bot.plugin("seen :nick") do |m|
   nick = m.args[:nick]
 
   if nick == bot.nick

data/lib/cinch.rb

@@ -9,7 +9,7 @@ require 'cinch/rules'
 require 'cinch/base'
 
 module Cinch
-  VERSION = '0.2'
+  VERSION = '0.2.3'
 
   # Setup bot options and return a new Cinch::Base instance
   def self.setup(ops={}, &blk)

data/lib/cinch/base.rb

@@ -62,6 +62,7 @@ module Cinch
 
       @rules = Rules.new
       @listeners = {}
+      @custom_types = {}
 
       @irc = IRC::Socket.new(options[:server], options[:port])
       @parser = IRC::Parser.new
@@ -138,9 +139,11 @@ module Cinch
     #
     # So far 3 types are supported:
     #
-    # * word - matches [a-zA-Z]+
+    # * word - matches [a-zA-Z_]+
     # * string - matches \w+
     # * digit - matches \d+
+    # * lower - matches [a-z]+
+    # * upper - matches [A-Z]+
     #
     # == Examples
     # For capturing individual words
@@ -189,10 +192,16 @@ module Cinch
             
             case type
             when 'digit'; "(\\d+?)"
-            when 'word'; "([a-zA-Z]+?)"
+            when 'word'; "([a-zA-Z_]+?)"
             when 'string'; "(\\w+?)"
+            when 'upper'; "([A-Z]+?)"
+            when 'lower'; "([a-z]+?)"
             else
-              "([^\x00\r\n]+?)"
+              if @custom_types.include?(type)
+                @custom_types[type]
+              else
+                "([^\x00\r\n]+?)"
+              end
             end
           else  
             keys << k[1..-1]
@@ -203,6 +212,24 @@ module Cinch
       ["^#{pattern}$", keys]
     end
 
+    # Add a custom 'type', for rule validation
+    #
+    # == Example
+    # bot = Cinch.setup do 
+    #   server 'irc.freenode.org'
+    #   port 6667
+    # end
+    #
+    # bot.add_custom_type(:number, "([0-9])")
+    #
+    # bot.plugin("getnum :foo-number") do |m|
+    #   m.reply "Your number was: #{m.args[:foo]}"
+    # end
+    def add_custom_type(name, pattern)
+      @custom_types[name.to_s] = pattern.to_s
+    end
+    alias :add_type :add_custom_type
+
     # Run run run
     def run      
       @irc.connect options.server, options.port
@@ -230,6 +257,11 @@ module Cinch
       end
 
       if [:privmsg].include?(message.symbol)
+
+        # At the moment we must traverse all possibly rules, which
+        # could get clunky with a lot of rules. This is because each
+        # rule can be unique in what prefix it uses, in future some kind
+        # of loose checking should be put in place
         rules.each do |rule|
           unless rule.options.key?(:prefix) || options.prefix == false
             rule.to_s.insert(1, options.prefix) unless rule.to_s[1].chr == options.prefix

data/lib/cinch/irc/message.rb

@@ -86,16 +86,20 @@ module Cinch
         @data[:host] = host
       end
 
+      # Reply to a channel or user, probably the most commonly used helper
+      # method
       def reply(text)
         recipient = data[:channel] || data[:nick]
         @irc.privmsg(recipient, text)
       end
 
+      # Same as reply but prefixes the users nickname
       def answer(text)
         return unless data[:channel]
         @irc.privmsg(data[:channel], "#{data[:nick]}: #{text}")
       end
 
+      # The deadly /me action
       def action(text)
         reply("\001ACTION #{text}\001")
       end

data/lib/cinch/rules.rb

@@ -20,15 +20,15 @@ module Cinch
     def execute(message)
       options.keys.each do |key|
         case key
-        when :nick
-          return unless options[:nick] == message.nick
-        when :host
-          return unless options[:host] == message.host
-        when :user
-          return unless options[:user] == message.user
-        when :channel
+        when :nick, :nicks
+          return unless validate(options[:nick], message.nick)
+        when :host, :hosts
+          return unless validate(options[:host], message.host)
+        when :user, :users
+          return unless validate(options[:user], message.user)
+        when :channel, :channels
           if message.channel
-            return unless options[:channel] == message.channel
+            return unless validate(options[:channel], message.channel)
           end
         end
       end
@@ -38,6 +38,16 @@ module Cinch
       end
     end
 
+    # Validate rule attributes
+    def validate(option, attr)
+      if option.is_a?(Array)
+        return unless option.any?{|o| o == attr }
+      else
+        return unless options.to_s == attr
+      end
+      true
+    end
+
     # The rule as a String
     def to_s
       rule

metadata

@@ -5,7 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  version: "0.2"
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Lee 'injekt' Jarvis
@@ -13,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-26 00:00:00 +01:00
+date: 2010-04-27 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -58,6 +59,7 @@ files:
 - lib/cinch/irc.rb
 - examples/join_part.rb
 - examples/msg.rb
+- examples/custom_types.rb
 - examples/seen.rb
 - examples/hello.rb
 - examples/named-param-types.rb