cinch 0.2.3 → 0.2.5

data/README.rdoc

@@ -105,8 +105,8 @@ This method also works for arrays, to only reply to a message sent in the foo an
    m.reply "Hello"
  end
 
-== Named Parameter Types
-Since version 0.2, Cinch supports named parameter types. It means stuff like the this works:
+== Named Parameter Patterns
+Since version 0.2, Cinch supports named parameter patterns. It means stuff like the this works:
 
  bot.plugin("say :n-digit :text") do |m|
    m.args[:n].to_i.times {
@@ -121,11 +121,12 @@ This would provide the following output on IRC
  Cinch> foo bar
  Cinch> foo bar
 
-* See Cinch::Base#compile for more information and the available types
+* See Cinch::Base#compile for more information and the available patterns
 
-Cinch also supports custom types. That's right, you can define you own type. Just like this:
+Cinch also supports custom named parameter patterns. That's right, you can define you own 
+pattern. Just like this:
 
- bot.add_custom_type(:friends, "(injekt|lee|john|bob)")
+ bot.add_custom_pattern(:friends, "(injekt|lee|john|bob)")
 
  bot.plugin("I like :friend-friends", :prefix => false) do |m|
    m.reply "I like #{m.args[:friend]} too!"

data/examples/autovoice.rb

@@ -0,0 +1,32 @@
+require 'cinch'
+
+# Give this bot ops in a channel and it'll auto voice 
+# visitors
+#
+# Enable with !autovoice on
+# Disable with !autovoice off
+
+bot = Cinch.setup do
+  server "irc.freenode.org"
+  channels %w( #cinch )
+end
+ 
+autovoice = true
+
+bot.on :join do |m|
+  unless m.nick == bot.options.nick # We shouldn't attempt to voice ourselves
+    bot.mode(m.channel, '+v', m.nick) if autovoice
+  end
+end
+
+bot.add_custom_pattern(:onoff, '(on|off)')
+
+bot.plugin "autovoice :option-onoff" do |m|
+  case m.args[:option]
+    when 'on'; autovoice = true
+    when 'off'; autovoice = false
+  end
+  m.answer "Autovoice is now #{autovoice ? 'enabled' : 'disabled'}"
+end
+
+bot.run

data/examples/{custom_types.rb → custom_patterns.rb}

@@ -1,12 +1,12 @@
-require 'cinch'
+require '/home/injekt/code/cinch/lib/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.add_custom_pattern(:friends, "(injekt|lee|john|bob)")
+bot.add_custom_pattern(:hex, "([\\dA-Fa-f]+?)")
 
 bot.plugin("I like :person-friends", :prefix => false) do |m|
   m.reply "I like #{m.args[:person]} too!"
@@ -17,4 +17,3 @@ bot.plugin("checkhex :n-hex") do |m|
 end
 
 bot.run
-

data/examples/memo.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+
+require 'cinch'
+
+bot = Cinch.setup do
+  server "irc.freenode.org"
+  channels %w( #cinch )
+end
+
+class Memo < Struct.new(:nick, :channel, :text, :time)
+  def to_s
+    "[#{time.asctime}] <#{channel}/#{nick}> #{text}"
+  end
+end
+
+@memos = {}
+
+bot.on :privmsg do |m|
+  if @memos.has_key?(m.nick)
+    bot.privmsg m.nick, @memos[m.nick].to_s
+    @memos.delete(m.nick)
+  end
+end
+
+bot.plugin("memo :nick-string :memo") do |m|
+  nick = m.args[:nick]
+
+  if @memos.key?(nick)
+    m.reply "There's already a memo #{nick}. You can only store one right now"
+  elsif nick == m.nick
+    m.reply "You can't leave memos for yourself.."
+  elsif nick == bot.options.nick
+    m.reply "You can't leave memos for me.."
+  else
+    @memos[nick] = Memo.new(m.nick, m.channel, m.args[:memo], Time.new)
+    m.reply "Added memo for #{nick}"
+  end
+end
+
+bot.run

data/lib/cinch.rb

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

data/lib/cinch/base.rb

@@ -62,7 +62,7 @@ module Cinch
 
       @rules = Rules.new
       @listeners = {}
-      @custom_types = {}
+      @custom_patterns = {}
 
       @irc = IRC::Socket.new(options[:server], options[:port])
       @parser = IRC::Parser.new
@@ -135,9 +135,9 @@ module Cinch
 
     # This method builds a regular expression from your rule
     # and defines all named parameters, as well as dealing with 
-    # types.
+    # patterns.
     #
-    # So far 3 types are supported:
+    # So far 3 patterns are supported:
     #
     # * word - matches [a-zA-Z_]+
     # * string - matches \w+
@@ -197,8 +197,8 @@ module Cinch
             when 'upper'; "([A-Z]+?)"
             when 'lower'; "([a-z]+?)"
             else
-              if @custom_types.include?(type)
-                @custom_types[type]
+              if @custom_patterns.include?(type)
+                @custom_patterns[type]
               else
                 "([^\x00\r\n]+?)"
               end
@@ -220,15 +220,16 @@ module Cinch
     #   port 6667
     # end
     #
-    # bot.add_custom_type(:number, "([0-9])")
+    # bot.add_custom_pattern(: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
+    def add_custom_pattern(name, pattern)
+      @custom_patterns[name.to_s] = pattern.to_s
     end
-    alias :add_type :add_custom_type
+    alias :add_custom_type :add_custom_pattern # backwards
+    alias :add_pattern :add_custom_pattern 
 
     # Run run run
     def run      

data/spec/base_spec.rb

@@ -82,19 +82,35 @@ describe "Cinch::Base" do
       keys.should be_empty
     end
 
-    it "should convert a digit type" do
+    it "should convert a digit pattern" do
       rule, keys = @base.compile(":foo-digit")
       rule.should == "^(\\d+?)$"
     end
 
-    it "should convert a string type" do
+    it "should convert a string pattern" do
       rule, keys = @base.compile(":foo-string")
       rule.should == "^(\\w+?)$"
     end
 
-    it "should convert a word type" do
+    it "should convert a word pattern" do
       rule, keys = @base.compile(":foo-word")
-      rule.should == "^([a-zA-Z]+?)$"
+      rule.should == "^([a-zA-Z_]+?)$"
+    end
+
+    it "should convert a lowercase pattern" do
+      rule, keys = @base.compile(":foo-lower")
+      rule.should == "^([a-z]+?)$"
+    end
+
+    it "should convert an uppercase pattern" do
+      rule, keys = @base.compile(":foo-upper")
+      rule.should == "^([A-Z]+?)$"
+    end
+
+    it "should convert a custom pattern" do
+      @base.add_custom_pattern(:people, "(foo|bar|baz)")
+      rule, keys = @base.compile(":foo-people")
+      rule.should == "^(foo|bar|baz)$"    
     end
 
     it "should automatically add start and end anchors" do

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 3
-  version: 0.2.3
+  - 5
+  version: 0.2.5
 platform: ruby
 authors: 
 - Lee 'injekt' Jarvis
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-27 00:00:00 +01:00
+date: 2010-04-28 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -59,9 +59,11 @@ files:
 - lib/cinch/irc.rb
 - examples/join_part.rb
 - examples/msg.rb
-- examples/custom_types.rb
+- examples/memo.rb
+- examples/custom_patterns.rb
 - examples/seen.rb
 - examples/hello.rb
+- examples/autovoice.rb
 - examples/named-param-types.rb
 has_rdoc: true
 homepage: http://rdoc.injekt.net/cinch