cinch 0.3.1 → 0.3.2

data/README.rdoc

@@ -41,14 +41,19 @@ Your typical <em>Hello, World</em> application would go something like this:
 It doesn't take much to work out what's happening here, but I'll explain it anyway.
 
 First we run the <em>Cinch::setup</em> block which is required in every application. Cinch is boxed
-with a load of default values, so the <b>only</b> option required in this block is the <em>server</em>
-option. 
+with a load of default values, so the <b>only</b> option required in this block is the server. 
 
 We then define a plugin using the <em>plugin</em> method and pass it a rule (a String in this
 case). Every plugin must be mapped to a rule. When the rule matches an IRC message its block is
 invoked, the contents of which contains your plugin interface. The variable passed to the block is
-an instance of IRC::Message. This provides us with a couple of helper methods which can be used to
-reply to a message. See Cinch::IRC::Message#reply and Cinch::IRC::Message#answer
+an instance of Cinch::IRC::Message.
+
+Cinch::IRC::Message also supplies us with some helper methods which aid in replying to users and 
+channels.
+
+=== See Also
+* Cinch::IRC::Message#reply
+* Cinch::IRC::Message#answer
 
 This example would provide the following response on IRC:
 
@@ -67,10 +72,10 @@ options within your script.
  ruby hello.rb -s irc.freenode.org -n Coolbot
  ruby hello.rb -C foo,bar
 
-Doing a <b>ruby hello.rb -h</b> provides all possible command line options. When using the <em>-C</em>
-or <em>--channels</em> option, the channel prefix is option, and if none is given the channel
-will be prefixed with a hash (#) 
-character 
+Doing a <b>ruby hello.rb -h</b> provides all possible command line options. 
+
+When using the <em>-C</em> or <em>--channels</em> option, the channel prefix is 
+optional, and if none is given the channel will be prefixed with a hash (#) character.
 
 == Plugins
 Plugins are invoked using the command prefix character (which by default is set to <b>!</b>). You can
@@ -150,7 +155,7 @@ This would provide the following output on IRC
 Cinch also supports custom named parameter patterns. That's right, you can define you own 
 pattern. Just like this:
 
- bot.add_custom_pattern(: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!"
@@ -176,7 +181,6 @@ channel or by email
 
 == Notes
 * RDoc API documentation is available {here}[http://rdoc.injekt.net/cinch]
-* Wiki is available {here}[https://github.com/injekt/cinch/wikis]
 * Issue and feature tracking is available {here}[https://github.com/injekt/cinch/issues]
 * Contribution in the form of bugfixes or feature requests is welcome and encouraged
 

data/examples/custom_patterns.rb

@@ -1,12 +1,12 @@
-require '/home/injekt/code/cinch/lib/cinch'
+require 'cinch'
 
 bot = Cinch.setup do 
   server "irc.freenode.org"
   channels %w{ #cinch }
 end
 
-bot.add_custom_pattern(:friends, "injekt|lee|john|bob")
-bot.add_custom_pattern(: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!"

data/examples/url_shorten.rb

@@ -0,0 +1,34 @@
+require 'open-uri'
+require 'cinch'
+
+# Automatically shorten URL's found in messages
+# Using the tinyURL API
+
+bot = Cinch.configure do
+  server "irc.freenode.org"
+  verbose true
+  channels %w/#cinch/
+end
+
+def shorten(url)
+  url = open("http://tinyurl.com/api-create.php?url=#{URI.escape(url)}").read
+  url == "Error" ? nil : url
+rescue OpenURI::HTTPError
+  nil
+end
+
+bot.on :privmsg do |m|
+  unless m.private?
+    urls = URI.extract(m.text, "http")
+
+    unless urls.empty?
+      short_urls = urls.map {|url| shorten(url) }.compact
+
+      unless short_urls.empty?
+        m.reply short_urls.join(", ")
+      end
+    end
+  end
+end
+
+bot.start

data/lib/cinch.rb

@@ -9,7 +9,7 @@ require 'cinch/rules'
 require 'cinch/base'
 
 module Cinch
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 
   class << self
 

data/lib/cinch/base.rb

@@ -28,9 +28,6 @@ module Cinch
     # An OpenStruct holding all configuration options
     attr_reader :options
 
-    # Hash of custom rule patterns
-    attr_reader :custom_patterns
-
     # Our IRC::Socket instance
     attr_reader :irc
 
@@ -73,58 +70,15 @@ module Cinch
       @listeners = {}
       @listeners[:ctcp] = {}
 
-      @custom_patterns = {
-        'digit' => "(\\d+?)",
-        'word' => "([a-zA-Z_]+?)",
-        'string' => "(\\w+?)",
-        'upper' => "([A-Z]+?)",
-        'lower' => "([a-z]+?)",
-      }
-
       @irc = IRC::Socket.new(options[:server], options[:port], options[:ssl])
       @parser = IRC::Parser.new
 
       # Default listeners
       on(:ping) {|m| @irc.pong(m.text) }
 
-      on(433) do |m|
-        @options.nick += @options.nick_suffix
-        @irc.nick @options.nick
-      end
-
-      if @options.respond_to?(:channels)
-        on("004") { @options.channels.each {|c| @irc.join(c) } }
-      end
-
       on(:ctcp, :version) {|m| m.ctcp_reply "Cinch IRC Bot Building Framework v#{Cinch::VERSION}"}
     end
 
-    # Parse command line options
-    def cli_ops
-      options = {}
-      if ARGV.any?
-        begin
-          OptionParser.new do |op|
-            op.on("-s server") {|v| options[:server] = v }
-            op.on("-p port") {|v| options[:port] = v.to_i }
-            op.on("-n nick") {|v| options[:nick] = v }
-            op.on("-c command_prefix") {|v| options[:prefix] = v }
-            op.on("-v", "--verbose", "Enable verbose mode") {|v| options[:verbose] = true }
-            op.on("--ssl") {|v| options[:ssl] = true }
-            op.on("-C", "--channels x,y,z", Array, "Autojoin channels") {|v|
-              options[:channels] = v.map {|c| %w(# + &).include?(c[0].chr) ? c : c.insert(0, '#') }
-            }
-          end.parse(ARGV)
-        rescue OptionParser::MissingArgument => err
-          warn "Missing values for options: #{err.args.join(', ')}\nFalling back to default"
-        rescue OptionParser::InvalidOption => err
-          warn err.message
-          exit
-        end
-      end
-      options
-    end
-
     # Add a new plugin
     #
     # == Example
@@ -150,6 +104,21 @@ module Cinch
     #    m.join "#mychan"
     #  end
     #
+    # This method also provides an alternative way to define a rule.
+    # The following are equivalent
+    #   plugin("foo bar") do |m|
+    #     m.reply "baz!"
+    #   end
+    #
+    #   on(:message, "foo bar") do |m|
+    #     m.reply "baz!"
+    #   end
+    # 
+    # This also gives us the opportunity to reply to CTCP messages
+    #  on(:ctcp, :time) do |m|
+    #    m.ctcp_reply Time.now.asctime
+    #  end
+    #
     # Note that when adding listeners for numberic IRC replies which
     # begin with a 0 (digit), make sure you define the command as a
     # String and not Integer. This is because 001.to_s == "1" so the
@@ -182,20 +151,9 @@ module Cinch
     # and defines all named parameters, as well as dealing with
     # patterns.
     #
-    # So far 3 patterns are supported:
-    #
-    # * word - matches [a-zA-Z_]+
-    # * string - matches \w+
-    # * digit - matches \d+
-    # * lower - matches [a-z]+
-    # * upper - matches [A-Z]+
+    # All patterns which exist in Cinch::IRC::Parser are supported
     #
     # == Examples
-    # === Capturing individual words
-    #  bot.plugin("say :text-word")
-    # * Does match !say foo
-    # * Does not match !say foo bar baz
-    #
     # === Capturing digits
     #  bot.plugin("say :text-digit")
     # * Does match !say 3
@@ -217,9 +175,9 @@ module Cinch
     #
     # Using "!say 3 injekt some text here" would provide
     # the following attributes
-    # m.args[:n] => 3
-    # m.args[:who] => injekt
-    # m.args[:text] => some text here
+    # * m.args[:n] => 3
+    # * m.args[:who] => injekt
+    # * m.args[:text] => some text here
     def compile(rule)
       return [rule, []] if rule.is_a?(Regexp)
       keys = []
@@ -235,8 +193,8 @@ module Cinch
             key, type = k.split('-')
             keys << key[1..-1]
             
-            if @custom_patterns.include?(type)
-              @custom_patterns[type]
+            if @parser.has_pattern?(type)
+              "(#{@parser.pattern(type)})"
             else
               "([^\x00\r\n]+?)"
             end
@@ -249,7 +207,7 @@ module Cinch
       ["^#{pattern}$", keys]
     end
 
-    # Add a custom 'type', for rule validation
+    # Add a custom pattern for rule validation
     #
     # == Example
     #  bot = Cinch.setup do
@@ -257,18 +215,28 @@ module Cinch
     #    port 6667
     #  end
     #
-    #  bot.add_custom_pattern(:number, "[0-9]")
+    #  bot.add_pattern(:number, /[0-9]/)
     #
     #  bot.plugin("getnum :foo-number") do |m|
     #    m.reply "Your number was: #{m.args[:foo]}"
     #  end
-    def add_custom_pattern(name, pattern)
-      @custom_patterns[name.to_s] = "(#{pattern.to_s})"
+    def add_pattern(name, pattern)
+      @parser.add_pattern(name, pattern)
     end
-    alias :add_pattern :add_custom_pattern
+    alias :add_custom_pattern :add_pattern
 
     # Run run run
     def run
+      # Configure some runtime listeners
+      on(433) do |m|
+        @options.nick += @options.nick_suffix
+        @irc.nick @options.nick
+      end
+
+      if @options.respond_to?(:channels)
+        on("004") { @options.channels.each {|c| @irc.join(c) } }
+      end
+
       @irc.connect options.server, options.port
       @irc.pass options.password if options.password
       @irc.nick options.nick
@@ -278,17 +246,19 @@ module Cinch
         process(@irc.read) while @irc.connected?
       rescue Interrupt
         @irc.quit("Interrupted")
-        puts "\nInterrupted. Shutting down.."
+        puts "\nInterrupted. Shutting down .."
         exit
       end
     end
     alias :start :run
 
+    private
+
     # Process the next line read from the server
     def process(line)
       return unless line
       message = @parser.parse(line)
-      message.irc = @irc
+      message.irc = @irc unless message.irc
       puts message if options.verbose
 
       # runs on any symbol
@@ -307,13 +277,10 @@ module Cinch
       end
 
       if [:privmsg].include?(message.symbol)
-
-        # At the moment we must traverse all possible 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|
           pattern = rule.to_s
+          rule.keys.map! {|key| key.to_sym }
+          prefix = nil
           
           if options.prefix
             if rule.options.key?(:prefix)
@@ -329,17 +296,20 @@ module Cinch
                 prefix = options.prefix
               end
             end
-          else
-            prefix = nil
           end
+          
+          # insert prefix unless it already exists
+          pattern.insert(1, prefix) unless pattern[1..prefix.size] == prefix
 
-          if prefix && pattern[1..prefix.size] != prefix
-            pattern.insert(1, prefix)
+          if rule.options[:ignore_case]
+            regex = Regexp.new(pattern, Regexp::IGNORECASE)
+          else
+            regex = Regexp.new(pattern)
           end
 
-          if message.text && mdata = message.text.rstrip.match(Regexp.new(pattern))
+          if message.text && mdata = message.text.rstrip.match(regex)
             unless rule.keys.empty? || mdata.captures.empty?
-              args = Hash[rule.keys.map {|k| k.to_sym}.zip(mdata.captures)]
+              args = Hash[rule.keys.zip(mdata.captures)]
               message.args = args
             end
             # execute rule
@@ -349,6 +319,31 @@ module Cinch
       end
     end
 
+    # Parse command line options
+    def cli_ops
+      options = {}
+      if ARGV.any?
+        begin
+          OptionParser.new do |op|
+            op.on("-s server") {|v| options[:server] = v }
+            op.on("-p port") {|v| options[:port] = v.to_i }
+            op.on("-n nick") {|v| options[:nick] = v }
+            op.on("-c command_prefix") {|v| options[:prefix] = v }
+            op.on("-v", "--verbose", "Enable verbose mode") {|v| options[:verbose] = true }
+            op.on("--ssl") {|v| options[:ssl] = true }
+            op.on("-C", "--channels x,y,z", Array, "Autojoin channels") {|v|
+              options[:channels] = v.map {|c| %w(# + &).include?(c[0].chr) ? c : c.insert(0, '#') }
+            }
+          end.parse(ARGV)
+        rescue OptionParser::MissingArgument => err
+          warn "Missing values for options: #{err.args.join(', ')}\nFalling back to default"
+        rescue OptionParser::InvalidOption => err
+          warn err.message
+        end
+      end
+      options
+    end
+
     # Catch methods
     def method_missing(meth, *args, &blk) # :nodoc:
       if options.respond_to?(meth)

data/lib/cinch/irc/parser.rb

@@ -7,9 +7,8 @@ module Cinch
     #
     # == Example
     #  require 'cinch/irc/parser'
-    #  include Cinch::IRC::Parser
     #
-    #  message = parse(":foo!bar@myhost.com PRIVMSG #mychan :ding dong!")
+    #  message = Cinch::IRC::Parser.parse(":foo!bar@myhost.com PRIVMSG #mychan :ding dong!")
     #
     #  message.class #=> Cinch::IRC::Message
     #  message.command #=> PRIVMSG
@@ -31,24 +30,30 @@ module Cinch
 
       # Add a new pattern
       def add_pattern(key, pattern)
-        raise ArgumentError, "Pattern is not a regular expression" unless pattern.is_a?(Regexp)
         @patterns[key.to_sym] = pattern
       end
 
       # Remove a pattern
       def remove_pattern(key)
-        key = key.to_sym
-        @patterns.delete(key) if @patterns.key?(key)
+        @patterns.delete(key.to_sym)
       end
 
       # Helper for our patterns Hash
       def pattern(key)
-        @patterns[key]
+        @patterns[key.to_sym]
+      end
+
+      # Check if a pattern exists
+      def has_pattern?(key)
+        @patterns.key?(key.to_sym)
       end
 
       # Set up some default patterns used directly by this class
       def setup_patterns
         add_pattern :letter, /[a-zA-Z]/
+        add_pattern :word, /\w+/
+        add_pattern :upper, /[A-Z]+/
+        add_pattern :lower, /[a-z]+/
         add_pattern :hex, /[\dA-Fa-f]/
 
         add_pattern :ip4addr, /\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}/

data/spec/base_spec.rb

@@ -33,12 +33,6 @@ describe "Cinch::Base" do
       @base.listeners.should include :ctcp
       @base.listeners[:ctcp].should include :version
     end
-
-    it "should add default custom_patterns" do
-      [:digit, :word, :string, :upper, :lower].each do |l|
-        @base.custom_patterns.should include l.to_s
-      end
-    end
   end
 
   describe "#plugin" do 
@@ -101,31 +95,6 @@ describe "Cinch::Base" do
       keys.should be_empty
     end
 
-    it "should convert a digit pattern" do
-      rule, keys = @base.compile(":foo-digit")
-      rule.should == "^(\\d+?)$"
-    end
-
-    it "should convert a string pattern" do
-      rule, keys = @base.compile(":foo-string")
-      rule.should == "^(\\w+?)$"
-    end
-
-    it "should convert a word pattern" do
-      rule, keys = @base.compile(":foo-word")
-      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")

data/spec/irc/parser_spec.rb

@@ -38,10 +38,6 @@ describe "IRC::Parser" do
       @parser.add_pattern(:custom, /foo/)
       @parser.patterns.key?(:custom)
     end
-
-    it "should raise ArgumentError if pattern is not Regexp" do
-      lambda { @parser.add_pattern(:custom, 'foo') }.should raise_error(ArgumentError)
-    end
   end
 
   describe "#remove_pattern" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cinch
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Lee 'injekt' Jarvis
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-26 00:00:00 +01:00
+date: 2010-07-08 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,33 +45,34 @@ extra_rdoc_files:
 files: 
 - README.rdoc
 - Rakefile
-- spec/base_spec.rb
-- spec/spec.opts
-- spec/irc/socket_spec.rb
-- spec/irc/helper.rb
 - spec/irc/message_spec.rb
 - spec/irc/parser_spec.rb
-- spec/helper.rb
+- spec/irc/socket_spec.rb
+- spec/irc/helper.rb
 - spec/rules_spec.rb
+- spec/spec.opts
 - spec/options_spec.rb
+- spec/base_spec.rb
+- spec/helper.rb
 - lib/cinch.rb
-- lib/cinch/base.rb
-- lib/cinch/irc/message.rb
 - lib/cinch/irc/socket.rb
+- lib/cinch/irc/message.rb
 - lib/cinch/irc/parser.rb
-- lib/cinch/rules.rb
 - lib/cinch/irc.rb
-- examples/google.rb
-- examples/custom_prefix.rb
+- lib/cinch/base.rb
+- lib/cinch/rules.rb
 - examples/join_part.rb
+- examples/named-param-types.rb
+- examples/url_shorten.rb
+- examples/custom_prefix.rb
+- examples/urban_dict.rb
 - examples/msg.rb
+- examples/hello.rb
+- examples/seen.rb
 - examples/memo.rb
 - examples/custom_patterns.rb
-- examples/urban_dict.rb
-- examples/seen.rb
-- examples/hello.rb
+- examples/google.rb
 - examples/autovoice.rb
-- examples/named-param-types.rb
 has_rdoc: true
 homepage: http://rdoc.injekt.net/cinch
 licenses: []