blackwinter-ruby-nuggets 0.4.0

data/lib/nuggets/object/singleton_class.rb

@@ -0,0 +1,150 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of ruby-nuggets, some extensions to the Ruby programming        #
+# language.                                                                   #
+#                                                                             #
+# Copyright (C) 2007-2008 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# ruby-nuggets is free software; you can redistribute it and/or modify it     #
+# under the terms of the GNU General Public License as published by the Free  #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# ruby-nuggets is distributed in the hope that it will be useful, but WITHOUT #
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with ruby-nuggets. If not, see <http://www.gnu.org/licenses/>.              #
+#                                                                             #
+###############################################################################
+#++
+
+class Object
+
+  # call-seq:
+  #   object.singleton_class => aClass
+  #
+  # Returns the singleton (or virtual/eigen/meta) class associated with _object_.
+  def singleton_class
+    class << self; self; end
+  end
+
+  alias_method :virtual_class, :singleton_class
+  alias_method :ghost_class,   :singleton_class
+  alias_method :eigenclass,    :singleton_class
+  alias_method :metaclass,     :singleton_class
+  alias_method :uniclass,      :singleton_class
+
+  # call-seq:
+  #   object.singleton_object => anObject
+  #
+  # Returns the object of which _object_ is the singleton_class.
+  # Raises a TypeError if _object_ is not a singleton class.
+  def singleton_object
+    [true, false, nil].each { |obj|
+      return obj if self.equal?(obj.singleton_class)
+    }
+
+    # raises TypeError if neither class nor module
+    ObjectSpace.each_object(self) { |obj|
+      return obj if self.equal?(obj.singleton_class)
+    }
+
+    # if we got here, it can't be a singleton class
+    # or its singleton object doesn't exist anymore
+    raise TypeError
+  rescue TypeError
+    raise TypeError, 'not a singleton class'
+  end
+
+  alias_method :virtual_object, :singleton_object
+  alias_method :ghost_object,   :singleton_object
+  alias_method :eigenobject,    :singleton_object
+  alias_method :metaobject,     :singleton_object
+  alias_method :uniobject,      :singleton_object
+
+  # call-seq:
+  #   object.singleton_class? => true or false
+  #
+  # Returns true if _object_ is a singleton_class
+  # (i.e., has a singleton_object), false otherwise.
+  def singleton_class?
+    singleton_object
+    true
+  rescue TypeError
+    false
+  end
+
+  alias_method :virtual_class?, :singleton_class?
+  alias_method :ghost_class?,   :singleton_class?
+  alias_method :eigenclass?,    :singleton_class?
+  alias_method :metaclass?,     :singleton_class?
+  alias_method :uniclass?,      :singleton_class?
+
+end
+
+if $0 == __FILE__
+  o = Object.new
+  p o
+  p o.singleton_class?
+
+  begin
+    p o.singleton_object
+  rescue TypeError => err
+    warn err
+  end
+
+  s = o.singleton_class
+  p s
+  p s.singleton_class?
+  p s.singleton_object
+
+  ###
+
+  o = [1, 2]
+  p o
+
+  s = o.singleton_class
+  p s
+  p s.singleton_class?
+  p s.singleton_object
+
+  ###
+
+  p Class.new.singleton_class?
+  p Class.singleton_class?
+
+  ###
+
+  c = Class.new
+  o = c.new
+  p o
+  p c.singleton_class?
+
+  ###
+
+  p nil.singleton_class
+  p NilClass.singleton_class?
+  p NilClass.singleton_object
+
+  ###
+
+  class A      # :nodoc:
+  end
+  class B < A  # :nodoc:
+  end
+
+  a = A.singleton_class
+  b = B.singleton_class
+
+  p a
+  p a.singleton_object  #=> A
+  p b
+  p b.singleton_object  #=> B
+end

data/lib/nuggets/object/uniclass.rb

@@ -0,0 +1,2 @@
+# whatever you prefer to call it...
+require 'nuggets/singleton_class'

data/lib/nuggets/object/virtual_class.rb

@@ -0,0 +1,2 @@
+# whatever you prefer to call it...
+require 'nuggets/singleton_class'

data/lib/nuggets/proc/bind.rb

@@ -0,0 +1,68 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of ruby-nuggets, some extensions to the Ruby programming        #
+# language.                                                                   #
+#                                                                             #
+# Copyright (C) 2007-2008 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# ruby-nuggets is free software; you can redistribute it and/or modify it     #
+# under the terms of the GNU General Public License as published by the Free  #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# ruby-nuggets is distributed in the hope that it will be useful, but WITHOUT #
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with ruby-nuggets. If not, see <http://www.gnu.org/licenses/>.              #
+#                                                                             #
+###############################################################################
+#++
+
+class Proc
+
+  # call-seq:
+  #   proc.bind(object) => aMethod
+  #
+  # Straight from Rails' ActiveSupport -- effectively binds _proc_ to +object+.
+  def bind(object)
+    block, time = self, Time.now
+
+    (class << object; self; end).class_eval {
+      method_name = "__bind_#{time.to_i}_#{time.usec}"
+      define_method(method_name, &block)
+
+      method = instance_method(method_name)
+      remove_method(method_name)
+
+      method
+    }.bind(object)
+  end
+
+end
+
+if $0 == __FILE__
+  l = lambda { bla }
+
+  begin
+    l.call
+  rescue NameError => err
+    puts "#{err} (#{err.class})"
+  end
+
+  module Bla  # :nodoc:
+
+    def self.bla
+      puts 'blub'
+    end
+
+  end
+
+  l.bind(Bla).call
+end

data/lib/nuggets/string/capitalize_first.rb

@@ -0,0 +1,63 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of ruby-nuggets, some extensions to the Ruby programming        #
+# language.                                                                   #
+#                                                                             #
+# Copyright (C) 2007-2008 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# ruby-nuggets is free software; you can redistribute it and/or modify it     #
+# under the terms of the GNU General Public License as published by the Free  #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# ruby-nuggets is distributed in the hope that it will be useful, but WITHOUT #
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with ruby-nuggets. If not, see <http://www.gnu.org/licenses/>.              #
+#                                                                             #
+###############################################################################
+#++
+
+class String
+
+  # call-seq:
+  #   str.capitalize_first => new_string
+  #
+  # Capitalizes the first character in +str+, but without downcasing the rest
+  # like String#capitalize does.
+  def capitalize_first
+    return self if empty?
+    self[0..0].upcase << self[1..-1]
+  end
+
+  # call-seq:
+  #   str.capitalize_first! => str
+  #
+  # Destructive version of #capitalize_first.
+  def capitalize_first!
+    replace capitalize_first
+  end
+
+end
+
+if $0 == __FILE__
+  s = 'Some string'
+  p s
+  p s.capitalize_first
+
+  s = 'some string'
+  p s
+  p s.capitalize_first
+
+  s = 'SOME STRING'
+  p s
+  p s.capitalize
+  p s.capitalize_first
+end

data/lib/nuggets/string/case.rb

@@ -0,0 +1,104 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of ruby-nuggets, some extensions to the Ruby programming        #
+# language.                                                                   #
+#                                                                             #
+# Copyright (C) 2007 Jens Wille                                               #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# ruby-nuggets is free software; you can redistribute it and/or modify it     #
+# under the terms of the GNU General Public License as published by the Free  #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# ruby-nuggets is distributed in the hope that it will be useful, but WITHOUT #
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with ruby-nuggets. If not, see <http://www.gnu.org/licenses/>.              #
+#                                                                             #
+###############################################################################
+#++
+
+class String
+
+  module Case
+
+    LOWER = :lower
+    UPPER = :upper
+    MIXED = :mixed
+
+  end
+
+  # call-seq:
+  #   str.case => aSymbol
+  #
+  # Returns a symbol indicating the case of _str_.
+  def case
+    self == downcase ? Case::LOWER :
+    self == upcase   ? Case::UPPER :
+                       Case::MIXED
+  end
+
+  # call-seq:
+  #   str.lower_case? => true or false
+  #
+  # Tell whether _str_ is all lower case.
+  def lower_case?
+    self.case == Case::LOWER
+  end
+  alias_method :downcase?, :lower_case?
+
+  # call-seq:
+  #   str.upper_case? => true or false
+  #
+  # Tell whether _str_ is all upper case.
+  def upper_case?
+    self.case == Case::UPPER
+  end
+  alias_method :upcase?, :upper_case?
+
+  # call-seq:
+  #   str.mixed_case? => true or false
+  #
+  # Tell whether _str_ is mixed case.
+  def mixed_case?
+    self.case == Case::MIXED
+  end
+
+  # call-seq:
+  #   str.capitalized? => true or false
+  #
+  # Tell whether _str_ is capitalized.
+  def capitalized?
+    self == capitalize
+  end
+
+end
+
+if $0 == __FILE__
+  s = 'Some string'
+  puts s
+  p    s.case
+  puts s.downcase?
+  puts s.upcase?
+  puts s.mixed_case?
+  puts s.capitalized?
+
+  s = 'some string'
+  puts s
+  p    s.case
+  puts s.downcase?
+  puts s.mixed_case?
+
+  s = 'SOME STRING'
+  puts s
+  p    s.case
+  puts s.upcase?
+  puts s.mixed_case?
+end

data/lib/nuggets/string/evaluate.rb

@@ -0,0 +1,53 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of ruby-nuggets, some extensions to the Ruby programming        #
+# language.                                                                   #
+#                                                                             #
+# Copyright (C) 2007 Jens Wille                                               #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# ruby-nuggets is free software; you can redistribute it and/or modify it     #
+# under the terms of the GNU General Public License as published by the Free  #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# ruby-nuggets is distributed in the hope that it will be useful, but WITHOUT #
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with ruby-nuggets. If not, see <http://www.gnu.org/licenses/>.              #
+#                                                                             #
+###############################################################################
+#++
+
+class String
+
+  # call-seq:
+  #   str.evaluate(binding = TOPLEVEL_BINDING) => new_str
+  #
+  # Basically turns Kernel#eval into an instance method of String -- inspired
+  # by Ruby Cookbook example 1.3. This allows to pre-populate strings with
+  # substitution expressions ("#{...}") that can get evaluated in a different
+  # environment (= +binding+) at a later point.
+  def evaluate(binding = TOPLEVEL_BINDING)
+    eval(%Q{"#{self}"}, binding)
+  end
+
+end
+
+if $0 == __FILE__
+  s = 'bl#{a}blub'
+  p s
+
+  def foo(bar) # :nodoc:
+    a = 'ub'
+    bar.evaluate(binding)
+  end
+
+  p foo(s)
+end

data/lib/nuggets/string/msub.rb

@@ -0,0 +1,82 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of ruby-nuggets, some extensions to the Ruby programming        #
+# language.                                                                   #
+#                                                                             #
+# Copyright (C) 2007 Jens Wille                                               #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# ruby-nuggets is free software; you can redistribute it and/or modify it     #
+# under the terms of the GNU General Public License as published by the Free  #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# ruby-nuggets is distributed in the hope that it will be useful, but WITHOUT #
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with ruby-nuggets. If not, see <http://www.gnu.org/licenses/>.              #
+#                                                                             #
+###############################################################################
+#++
+
+require 'nuggets/string/evaluate'
+
+class String
+
+  # call-seq:
+  #   str.msub(*substitutions) => new_str
+  #
+  # Performs _multiple_ substitutions on _str_ with order being taken into
+  # account (thus results of previous substitutions won't be subject to later
+  # ones) -- inspired by Ruby Cookbook example 1.18.
+  #
+  # The +substitutions+ parameter can be an array or a list of <tt>[pattern,
+  # substitution]</tt> pairs, or, simply, a hash. Note that, when using a hash,
+  # the ordering of how substitutions are processed might differ from what you
+  # intended -- instead use an array when order matters. +pattern+ can be a
+  # string or a regexp, +substitution+ may contain string expressions (cf.
+  # #evaluate).
+  def msub(*substitutions)
+    (_dup = dup).msub!(*substitutions) || _dup
+  end
+
+  # call-seq:
+  #   str.msub!(*substitutions) => str or nil
+  #
+  # Destructive version of #msub.
+  def msub!(*substitutions)
+    substitutions = *substitutions  # Handle hashes and arrays alike
+    keys, subs, cache = [], [], {}
+
+    substitutions.each { |key, value|
+      key = Regexp.new(Regexp.escape(key)) unless key.is_a?(Regexp)
+
+      keys << key
+      subs << [key, value]
+    }
+
+    gsub!(Regexp.union(*keys)) { |match|
+      cache[match] ||= subs.find { |key, _|
+        key =~ match
+      }.last.evaluate(binding)
+    }
+  end
+
+end
+
+if $0 == __FILE__
+  s = 'Foo, Bar - Baz'
+  p s
+
+  p s.gsub(/a/, 'o').gsub(/o/, 'a')
+  p s.msub('a' => 'o', 'o' => 'a')
+
+  s.msub!('a' => 'o','o' => 'a')
+  p s
+end

data/lib/nuggets/string/nsub.rb

@@ -0,0 +1,80 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of ruby-nuggets, some extensions to the Ruby programming        #
+# language.                                                                   #
+#                                                                             #
+# Copyright (C) 2007-2008 Jens Wille                                          #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# ruby-nuggets is free software; you can redistribute it and/or modify it     #
+# under the terms of the GNU General Public License as published by the Free  #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# ruby-nuggets is distributed in the hope that it will be useful, but WITHOUT #
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with ruby-nuggets. If not, see <http://www.gnu.org/licenses/>.              #
+#                                                                             #
+###############################################################################
+#++
+
+class String
+
+  # call-seq:
+  #   str.nsub(pattern, replacement, count) => new_str
+  #   str.nsub(pattern, count) { |match| ... } => new_str
+  #
+  # Returns a copy of _str_ with the _first_ +count+ occurrences of pattern
+  # replaced with either +replacement+ or the value of the block.
+  def nsub(*args)
+    _dup = dup
+    (block_given? ?
+      _dup.nsub!(*args) { |*a| yield(*a) } :
+      _dup.nsub!(*args)) || _dup
+  end
+
+  # call-seq:
+  #   str.nsub!(pattern, replacement, count) => str or nil
+  #   str.nsub!(pattern, count) { |match| ... } => str or nil
+  #
+  # Performs the substitutions of #nsub in place, returning _str_, or +nil+ if
+  # no substitutions were performed.
+  def nsub!(*args)
+    pattern, i = args.first, 0
+
+    case args.size
+      when 2
+        # Only +count+ given
+        count = args.last
+
+        gsub!(pattern) { |match| (i += 1) <= count ? yield(match) : match }
+      when 3
+        # Both +replacement+ and +count+ given;
+        # ignore block (just like String#gsub does)
+        replacement, count = args.values_at(1, 2)
+
+        gsub!(pattern) { |match| (i += 1) <= count ? replacement : match }
+      else
+        raise ArgumentError, "wrong number of arguments (#{args.size} for 2-3)"
+    end
+  end
+
+end
+
+if $0 == __FILE__
+  s = 'a b c d e f g h i'
+  puts s
+
+  puts s.nsub(' ', '', 6)
+  puts s.nsub(' ', 6) { '' }
+
+  s.nsub!(' ', '', 6)
+  puts s
+end