X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=lib%2Frbot%2Fcore%2Futils%2Fextends.rb;h=08278261fdfa435b21991a069cd66cb7664b9d31;hb=7b792bea7a644309623d67b5d49528ae13da3e7b;hp=f3861745442035ebb60e926b61188ec3c0d5aec8;hpb=cfc6d31ac24b3c705eaa7302ced01d5f33135dc4;p=user%2Fhenk%2Fcode%2Fruby%2Frbot.git diff --git a/lib/rbot/core/utils/extends.rb b/lib/rbot/core/utils/extends.rb index f3861745..08278261 100644 --- a/lib/rbot/core/utils/extends.rb +++ b/lib/rbot/core/utils/extends.rb @@ -4,8 +4,6 @@ # :title: Standard classes extensions # # Author:: Giuseppe "Oblomov" Bilotta -# Copyright:: (C) 2006,2007 Giuseppe Bilotta -# License:: GPL v2 # # This file collects extensions to standard Ruby classes and to some core rbot # classes to be used by the various plugins @@ -109,6 +107,78 @@ class ::Array end self.delete_at(index) end + + # This method deletes a given object _el_ if it's found at the given + # position _pos_. The position can be either an integer or a range. + def delete_if_at(el, pos) + idx = self.index(el) + if pos === idx + self.delete_at(idx) + else + nil + end + end + + # Taken from Ruby backports: + # shuffle and shuffle! are defined in Ruby >= 1.8.7 + + # This method returns a new array with the + # same items as the receiver, but shuffled + def shuffle + dup.shuffle! + end unless method_defined? :shuffle + + def shuffle! + size.times do |i| + r = i + Kernel.rand(size - i) + self[i], self[r] = self[r], self[i] + end + self + end unless method_defined? :shuffle! +end + +module ::Enumerable + # This method is an advanced version of #join + # allowing fine control of separators: + # + # [1,2,3].conjoin(', ', ' and ') + # => "1, 2 and 3 + # + # [1,2,3,4].conjoin{ |i, a, b| i % 2 == 0 ? '.' : '-' } + # => "1.2-3.4" + # + # Code lifted from the ruby facets project: + # + # git-rev: c8b7395255b977d3c7de268ff563e3c5bc7f1441 + # file: lib/core/facets/array/conjoin.rb + def conjoin(*args, &block) + num = count - 1 + + return first.to_s if num < 1 + + sep = [] + + if block_given? + num.times do |i| + sep << yield(i, *slice(i, 2)) + end + else + options = (Hash === args.last) ? args.pop : {} + separator = args.shift || "" + options[-1] = args.shift unless args.empty? + + sep = [separator] * num + + if options.key?(:last) + options[-1] = options.delete(:last) + end + options[-1] ||= _(" and ") + + options.each{ |i, s| sep[i] = s } + end + + zip(sep).join + end end # Extensions to the Range class @@ -186,6 +256,29 @@ class ::String warning "unknown :a_href option #{val} passed to ircify_html" if val end + # If opts[:img] is defined, it should be a String. Each image + # will be replaced by the string itself, replacing occurrences of + # %{alt} %{dimensions} and %{src} with the alt text, image dimensions + # and URL + if val = opts[:img] + if val.kind_of? String + txt.gsub!(//) do |imgtag| + attrs = Hash.new + imgtag.scan(/([[:alpha:]]+)\s*=\s*(['"])?(.*?)\2/) do |key, quote, value| + k = key.downcase.intern rescue 'junk' + attrs[k] = value + end + attrs[:alt] ||= attrs[:title] + attrs[:width] ||= '...' + attrs[:height] ||= '...' + attrs[:dimensions] ||= "#{attrs[:width]}x#{attrs[:height]}" + val % attrs + end + else + warning ":img option is not a string" + end + end + # Paragraph and br tags are converted to whitespace txt.gsub!(/<\/?(p|br)(?:\s+[^>]*)?\s*\/?\s*>/i, ' ') txt.gsub!("\n", ' ') @@ -248,7 +341,7 @@ class ::String # This method will strip all HTML crud from the receiver # def riphtml - self.gsub(/<[^>]+>/, '').gsub(/&/,'&').gsub(/"/,'"').gsub(/</,'<').gsub(/>/,'>').gsub(/&ellip;/,'...').gsub(/'/, "'").gsub("\n",'') + Utils.decode_html_entities(self.gsub("\n",' ').gsub(/<\s*br\s*\/?\s*>/, ' ').gsub(/<[^>]+>/, '')).gsub(/\s+/,' ') end # This method tries to find an HTML title in the string, @@ -267,8 +360,39 @@ class ::String def ircify_html_title self.get_html_title.ircify_html rescue nil end -end + # This method is used to wrap a nonempty String by adding + # the prefix and postfix + def wrap_nonempty(pre, post, opts={}) + if self.empty? + String.new + else + "#{pre}#{self}#{post}" + end + end + + # Format a string using IRC colors + # + def colorformat + txt = self.dup + + txt.gsub!(/\*([^\*]+)\*/, Bold + '\\1' + NormalText) + + return txt + end + + # Removes non-ASCII symbols from string + def remove_nonascii(replace='') + encoding_options = { + :invalid => :replace, # Replace invalid byte sequences + :undef => :replace, # Replace anything not defined in ASCII + :replace => replace, + :universal_newline => true # Always break lines with \n + } + + self.encode(Encoding.find('ASCII'), encoding_options) + end +end # Extensions to the Regexp class, with some common and/or complex regular # expressions. @@ -384,6 +508,10 @@ module ::Irc # the :target, the message :class and whether or not to :delegate. To # initialize these entries from an existing message, you can use :from # + # Additionally, if :from is given, the reply method of created message + # is overriden to reply to :from instead. The #in_thread attribute + # for created mesage is also copied from :from + # # If you don't specify a :from you should specify a :source. # def fake_message(string, opts={}) @@ -402,6 +530,21 @@ module ::Irc raise RecurseTooDeep if o[:depth] > MAX_RECURSE_DEPTH new_m = o[:class].new(o[:bot], o[:server], o[:source], o[:target], string) new_m.recurse_depth = o[:depth] + if from + # the created message will reply to the originating message, but we + # must remember to set 'replied' on the fake message too, to + # prevent infinite loops that could be created for example with the reaction + # plugin by setting up a reaction to ping with cmd:ping + class << new_m + self + end.send(:define_method, :reply) do |*args| + debug "replying to '#{from.message}' with #{args.first}" + from.reply(*args) + new_m.replied = true + end + # the created message will follow originating message's in_thread + new_m.in_thread = from.in_thread if from.respond_to?(:in_thread) + end return new_m unless o[:delegate] method = o[:class].to_s.gsub(/^Irc::|Message$/,'').downcase method = 'privmsg' if method == 'priv'