glue 0.13.0 → 0.14.0

data/vendor/extensions/object.rb

@@ -0,0 +1,164 @@
+#!/usr/local/bin/ruby -w
+
+#
+# == extensions/object.rb
+#
+# Adds methods to the builtin Object class.
+#
+
+require 'extensions/_base'
+
+
+#
+# Object#singleton_class
+#
+ExtensionsProject.implement(Object, :singleton_class) do
+  class Object
+    #
+    # Returns the singleton class associated with this object.  How useful this
+    # is I don't know, but it's an idiom that has appeared on ruby-talk several
+    # times.
+    #
+    def singleton_class
+      class << self
+        self
+      end
+    end
+  end
+end
+
+
+#
+# * Object.in?
+# This has special treatment: it's included here and in enumerable.rb, so we don't
+# want a warning if it's already defined.
+#
+unless Object.method_defined?(:in?)
+  ExtensionsProject.implement(Object, :in?) do
+    class Object
+      #
+      # Test this object for inclusion in a given collection.
+      #
+      #   45.in? (1...100)             => true
+      #
+      # This method is contained in <tt>object.rb</tt> and
+      # <tt>enumerable.rb</tt>, because it logically belongs in both.
+      #
+      def in?(enumerable)
+        enumerable.include?(self)
+      end
+    end
+  end
+end
+
+
+#
+# * Object.not_nil?
+#
+ExtensionsProject.implement(Object, :not_nil?) do
+  class Object
+    #
+    # The opposite of <tt>#nil?</tt>.
+    #
+    #   "hello".not_nil?      # -> true
+    #   nil.not_nil?          # -> false 
+    #
+    def not_nil?
+      not self.nil?
+    end
+  end
+end
+
+
+#
+# * Object.non_nil?
+#
+ExtensionsProject.implement(Object, :non_nil?) do
+  class Object
+    #
+    # The opposite of <tt>#nil?</tt>.
+    #
+    #   "hello".non_nil?      # -> true
+    #   nil.non_nil?          # -> false 
+    #
+    def non_nil?
+      not self.nil?
+    end
+  end
+end
+
+
+#
+# Object#pp_s
+#
+ExtensionsProject.implement(Object, :pp_s) do
+  require 'pp'
+  require 'stringio'
+  class Object
+    #
+    # Returns a pretty-printed string of the object.  Requires libraries +pp+ and
+    # +stringio+ from the Ruby standard library.
+    #
+    # The following code pretty-prints an object (much like +p+ plain-prints an
+    # object):
+    #
+    #   pp object
+    #
+    # The following code captures the pretty-printing in +str+ instead of
+    # sending it to +STDOUT+.
+    #
+    #   str = object.pp_s 
+    #
+    def pp_s
+      pps = StringIO.new
+      PP.pp(self, pps)
+      pps.string
+    end
+  end
+end
+
+#
+# Object#pp_s
+#
+ExtensionsProject.implement(Object, :define_method) do
+  class Object
+    #
+    # Defines a singleton method on the object.  For example, the following are
+    # equivalent (assume <tt>o = Object.new</tt>):
+    #
+    #   def o.add(x, y)
+    #     x + y
+    #   end
+    #
+    #   o.define_method(:add) do |x, y|
+    #     x + y
+    #   end
+    #
+    # The difference is that with <tt>define_method</tt>, you can use variables
+    # local to the _current_ scope.
+    #
+    #   x = 5 
+    #   o.define_method(:add_x) do |n|
+    #     x + n
+    #   end
+    #   o.add_x(11)          # -> 16
+    #
+    # You can't define such a method as <tt>add_x</tt> above with <tt>def
+    # o.add_x; x + n; end</tt>, as +def+ introduces a new scope.
+    #
+    # There are three ways to provide the body of the method: with a block (as
+    # in both examples above), or with a +Proc+ or +Method+ object.  See the
+    # built-in method <tt>Module#define_method</tt> for details.
+    #
+    # (This method is exactly equivalent to calling <tt>Module#define_method</tt>
+    # in the scope of the singleton class of the object.) 
+    #
+    def define_method(*args, &block)
+      singleton_class = class << self; self; end
+      singleton_class.module_eval do
+        define_method(*args, &block)
+      end
+    end
+  end
+end
+

data/vendor/extensions/ostruct.rb

@@ -0,0 +1,41 @@
+#!/usr/local/bin/ruby -w
+#
+# == extensions/ostruct.rb
+#
+# Adds methods to the standard library's OpenStruct class. 
+#
+
+require "extensions/_base"
+require 'ostruct'
+
+#
+# * OpenStruct#initialize
+#
+ExtensionsProject.implement(OpenStruct, :initialize) do
+  class OpenStruct
+    alias old_initialize initialize
+    private :old_initialize
+
+    #
+    # Allows the initialization of an OpenStruct with a block:
+    #
+    #   person = OpenStruct.new do |p|
+    #     p.name    = 'John Smith'
+    #     p.gender  = :M
+    #     p.age     = 71
+    #   end 
+    #
+    # You can still provide a hash for initialization purposes, and even combine
+    # the two approaches if you wish.
+    #
+    #   person = OpenStruct.new(:name => 'John Smith', :age => 31) do |p|
+    #     p.gender = :M 
+    #   end
+    #
+    def initialize(*args) # :yield: self
+      old_initialize(*args)
+      yield self if block_given?
+    end
+  end
+end
+

data/vendor/extensions/string.rb

@@ -0,0 +1,316 @@
+#!/usr/local/bin/ruby -w
+
+#
+# == extensions/string.rb
+#
+# Adds methods to the builtin String class.
+#
+
+require "extensions/_base"
+
+
+ExtensionsProject.implement(String, :leftmost_indent) do
+  class String
+    #
+    # Returns the size of the smallest indent of any line in the string.
+    # Emits a warning if tabs are found, and if <tt>$VERBOSE</tt> is on.
+    # You can use #expand_tabs to avoid this.  This method is primarily intended
+    # for use by #tabto and is not likely to be all that useful in its own
+    # right.
+    #
+    def leftmost_indent
+      tabs_found = false
+      scan(/^([ \t]*)\S/).flatten.map { |ws|
+        tabs_found = true if ws =~ /\t/
+        ws.size
+      }.compact.min
+    ensure
+      if tabs_found and $VERBOSE
+        $stderr.puts %{
+String#leftmost_indent: warning: tabs treated as spaces
+  (value: #{self.inspect[0..30]}...")
+          }.strip
+      end
+    end
+    protected :leftmost_indent
+  end
+end
+
+
+ExtensionsProject.implement(String, :expand_tabs) do
+  class String
+    #
+    # Expands tabs to +n+ spaces.  Non-destructive.  If +n+ is 0, then tabs are
+    # simply removed.  Raises an exception if +n+ is negative.
+    #
+    #--
+    # Thanks to GGaramuno for a more efficient algorithm.  Very nice.
+    def expand_tabs(n=8)
+      n = n.to_int
+      raise ArgumentError, "n must be >= 0" if n < 0
+      return gsub(/\t/, "") if n == 0
+      return gsub(/\t/, " ") if n == 1
+      str = self.dup
+      while
+        str.gsub!(/^([^\t\n]*)(\t+)/) { |f|
+          val = ( n * $2.size - ($1.size % n) )
+          $1 << (' ' * val)
+        }
+      end
+      str
+    end
+  end
+end
+
+
+ExtensionsProject.implement(String, :indent) do
+  class String
+    #
+    # Indents the string +n+ spaces.
+    #
+    def indent(n)
+      n = n.to_int
+      return outdent(-n) if n < 0
+      gsub(/^/, " "*n)
+    end
+  end
+end
+
+
+ExtensionsProject.implement(String, :outdent) do
+  class String
+    #
+    # Outdents the string +n+ spaces.  Initial tabs will cause problems and
+    # cause a warning to be emitted (if warnings are on).  Relative indendation
+    # is always preserved.  Once the block hits the beginning of the line,
+    # that's it.  In the following example, <tt>.</tt> represents space from the
+    # beginning of the line.
+    #
+    #   str = %{
+    #   ..One
+    #   ....Two
+    #   }.outdent(4)
+    #
+    # is
+    #
+    #   One
+    #   ..Two
+    #
+    def outdent(n)
+      n = n.to_int
+      return indent(-n) if n < 0
+      tabto(leftmost_indent - n)
+    end
+  end
+end
+
+
+ExtensionsProject.implement(String, :tabto) do
+  class String
+    #
+    # Move the string to the <tt>n</tt>th column.  Relative indentation is preserved.
+    # Column indices begin at 0, so the result is that the leftmost character of
+    # the string has +n+ spaces before it.
+    #
+    # Examples:
+    #   "xyz".tabto(0)           # -> "xyz"
+    #   "xyz".tabto(1)           # -> " xyz"
+    #   "xyz".tabto(2)           # -> "  xyz"
+    #   "   xyz".tabto(1)        # -> " xyz"
+    #
+    #   str = <<EOF
+    #       Hello, my name
+    #     is Gerald.
+    #   EOF
+    #   str.tabto(5) == <<EOF    # -> true
+    #          Hello, my name
+    #        is Gerald.
+    #   EOF
+    #
+    def tabto(n)
+      n = n.to_int
+      n = 0 if n < 0
+      find = " " * leftmost_indent()
+      replace = " " * (n)
+      gsub(/^#{find}/, replace)
+    end
+  end
+end
+
+
+ExtensionsProject.implement(String, :taballto) do
+  class String
+    #
+    # Tabs all lines in the string to column +n+.  That is, relative indentation
+    # is _not_ preserved.
+    #
+    def taballto(n)
+      n = n.to_int
+      n = 0 if n < 0
+      gsub(/^[ \t]*/, " "*n)
+    end
+  end
+end
+
+
+ExtensionsProject.implement(String, :trim) do
+  class String
+    #
+    # Trims a string:
+    # - removes one initial blank line
+    # - removes trailing spaces on each line
+    # - if +margin+ is given, removes initial spaces up to and including
+    #   the margin on each line, plus one space
+    #
+    # This is designed specifically for working with inline documents.
+    # Here-documents are great, except they tend to go against the indentation
+    # of your code.  This method allows a convenient way of using %{}-style
+    # documents.  For instance:
+    #
+    #   USAGE = %{
+    #     | usage: prog [-o dir] -h file...
+    #     |   where
+    #     |     -o dir         outputs to DIR
+    #     |     -h             prints this message
+    #   }.trim("|")
+    #
+    #   # USAGE == "usage: prog [-o dir] -h file...\n  where"...
+    #   # (note single space to right of margin is deleted)
+    #
+    # Note carefully that if no margin string is given, then there is no
+    # clipping at the beginning of each line and your string will remain
+    # indented.  You can use <tt>tabto(0)</tt> to align it with the left of
+    # screen (while preserving relative indentation).
+    #
+    #   USAGE = %{
+    #     usage: prog [-o dir] -h file...
+    #       where
+    #         -o dir         outputs to DIR
+    #         -h             prints this message
+    #   }.trim.tabto(0)
+    #
+    #   # USAGE == (same as last example)
+    #
+    def trim(margin=nil)
+      s = self.dup
+      # Remove initial blank line.
+      s.sub!(/\A[ \t]*\n/, "")
+      # Get rid of the margin, if it's specified.
+      unless margin.nil?
+        margin_re = Regexp.escape(margin || "")
+        margin_re = /^[ \t]*#{margin_re} ?/
+        s.gsub!(margin_re, "")
+      end
+      # Remove trailing whitespace on each line
+      s.gsub!(/[ \t]+$/, "")
+      s
+    end
+  end
+end
+
+
+ExtensionsProject.implement(String, :starts_with?) do
+  class String
+    #
+    # Returns true iff this string starts with +str+.
+    #    "Hello, world".starts_with?("He")         # -> true
+    #    "Hello, world".starts_with?("Green")      # -> false
+    #
+    def starts_with?(str)
+      str = str.to_str
+      head = self[0, str.length]
+      head == str
+    end
+  end
+end
+
+
+ExtensionsProject.implement(String, :ends_with?) do
+  class String
+    #
+    # Returns true iff this string ends with +str+.
+    #    "Hello, world".ends_with?(", world")    # -> true
+    #    "Hello, world".ends_with?("Green")      # -> false
+    #
+    def ends_with?(str)
+      str = str.to_str
+      tail = self[-str.length, str.length]
+      tail == str      
+    end
+  end
+end
+
+
+ExtensionsProject.implement(String, :line) do
+  class String
+    #
+    # Returns a line or lines from the string.  +args+ can be a single integer,
+    # two integers or a range, as per <tt>Array#slice</tt>.  The return value is
+    # a single String (a single line), an array of Strings (multiple lines) or
+    # +nil+ (out of bounds).  Note that lines themselves do not contain a
+    # trailing newline character; that is metadata.  Indexes out of bounds are
+    # ignored.
+    #
+    #   data = " one \n two \n three \n four \n five \n"
+    #   data.line(1)              # -> " two "
+    #   data.line(0,1)            # -> [" one "]
+    #   data.line(3..9)           # -> [" four ", " five "]
+    #   data.line(9)              # -> nil
+    #
+    def line(*args)
+      self.split(/\n/).slice(*args)
+    rescue TypeError
+      raise TypeError,
+        "String#line(*args): args must be one Integer, two Integers or a Range"
+    rescue ArgumentError
+      raise ArgumentError,
+        "String#line(*args): args must be one Integer, two Integers or a Range"
+    end
+  end
+end
+
+
+ExtensionsProject.implement(String, :cmp) do
+  class String
+    #
+    # Compare this string to +other+, returning the first index at which they
+    # differ, or +nil+ if they are equal.
+    #
+    #   "practise".cmp("practice")    # -> 6
+    #   "noun".cmp("nouns")           # -> 5 (and vice versa) 
+    #   "fly".cmp("fly")              # -> nil 
+    #
+    def cmp(other)
+      other = other.to_str
+      if self == other
+        return nil
+      else
+        n = [self.size, other.size].min
+        (0..n).each do |i|
+          return i unless self[i] == other[i]
+        end
+      end
+    end
+  end
+end
+
+
+ExtensionsProject.implement(String, :join) do
+  class String
+    #
+    # Join all the lines of the string together, and compress spaces.  The resulting string
+    # will have no surrounding whitespace.
+    #
+    #   text = %{
+    #     Once upon a time,
+    #          Little Red Riding Hood ...
+    #
+    #   }
+    #
+    #   text.join   # -> "Once upon a time, Little Red Riding Hood ..."
+    #
+    def join
+      gsub(/([ \t]*\n[ \t]*)+/, ' ').strip
+    end
+  end
+end