facets 1.1.0 → 1.2.0

data/lib/facets/core/range/umbrella.rb

@@ -0,0 +1,67 @@
+class Range
+
+  # Returns a two element array of the relationship
+  # between two Ranges.
+  #
+  # Diagram:
+  #
+  #     Relationship     Returns
+  #
+  #   self |-----------|
+  #   r    |-----------|    [0,0]
+  #
+  #   self |-----------|
+  #   r     |---------|     [-1,-1]
+  #
+  #   self  |---------|
+  #   r    |-----------|    [1,1]
+  #
+  #   self |-----------|
+  #   r     |----------|    [-1,0]
+  #
+  #   self |-----------|
+  #   r     |-----------|   [-1,1]
+  #
+  #   etc.
+  #
+  # Example:
+  #
+  #   (0..3).umbrella(1..2)  #=>  [-1,-1]
+  #
+  def umbrella(r)
+    s = self.first <=> r.first
+    e = r.last <=> self.last
+    return s,e
+  end
+
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class TCRange < Test::Unit::TestCase
+
+    def test_umbrella
+      assert_equal( [1,1], (3..6).umbrella(2..7) )
+      assert_equal( [0,1], (3..6).umbrella(3..7) )
+      assert_equal( [-1,1], (3..6).umbrella(4..7) )
+      assert_equal( [1,0], (3..6).umbrella(2..6) )
+      assert_equal( [0,0], (3..6).umbrella(3..6) )
+      assert_equal( [-1,0], (3..6).umbrella(4..6) )
+      assert_equal( [1,-1], (3..6).umbrella(2..5) )
+      assert_equal( [0,-1], (3..6).umbrella(3..5) )
+      assert_equal( [-1,-1], (3..6).umbrella(4..5) )
+    end
+
+  end
+
+=end

data/lib/facets/core/range/within.rb

@@ -0,0 +1,44 @@
+require 'facet/range/umbrella'
+
+class Range
+
+  # Uses the Range#umbrella method to determine
+  # if another Range is _anywhere_ within this Range.
+  #
+  #   (1..3).within?(0..4)  #=> true
+  #
+  def within?(rng)
+    case rng.umbrella(self)
+    when [0,0], [-1,0], [0,-1], [-1,-1]
+      return true
+    else
+      return false
+    end
+  end
+
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class TCRange < Test::Unit::TestCase
+
+    def test_within?
+      assert( (4..5).within?(3..6) )
+      assert( (3..6).within?(3..6) )
+      assert(! (2..5).within?(3..6) )
+      assert(! (5..7).within?(3..6) )
+    end
+
+  end
+
+=end

data/lib/facets/core/regexp.rb

@@ -0,0 +1,3 @@
+require 'facets/core/regexp/arity'
+require 'facets/core/regexp/to_re'
+require 'facets/core/regexp/to_regexp'

data/lib/facets/core/regexp/arity.rb

@@ -0,0 +1,41 @@
+class Regexp
+  # Returns the number of backreferencing subexpressions.
+  #
+  #   /(a)(b)(c)/.arity  #=> 3
+  #   /(a(b(c)))/.arity  #=> 3
+  #
+  # Note: This is not perfect, especially with regards to \x
+  # and embedded comments.
+  def arity
+    self.source.scan( /(?!\\)[(](?!\?[#=:!>-imx])/ ).length
+  end
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class TCRegexp < Test::Unit::TestCase
+
+    def test_arity
+      r = /(1)(2)(3)/
+      assert_equal( 3, r.arity )
+      r = /(1)(2)(3)(4)/
+      assert_equal( 4, r.arity )
+      r = /(1)(2)((a)3)/
+      assert_equal( 4, r.arity )
+      r = /(?#nothing)(1)(2)(3)(?=3)/
+      assert_equal( 3, r.arity )
+    end
+
+  end
+
+=end

data/lib/facets/core/regexp/to_re.rb

@@ -0,0 +1,38 @@
+class Regexp
+
+  # Simply returns itself. Helpful when converting
+  # strings to regular expressions, where regexp
+  # might occur as well --in the same vien as using
+  # #to_s on symbols. The parameter is actaully a 
+  # dummy parameter to coincide with String#to_re.
+  #
+  #   /abc/.to_re  #=> /abc/
+  #
+  def to_re( esc=false )
+    self  # Of course, things really should know how to say "I" ;)
+  end
+
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class TCRegexp < Test::Unit::TestCase
+
+    def test_to_re
+      r = /0..10/
+      assert_equal( r, r.to_re )
+    end
+
+  end
+
+=end

data/lib/facets/core/regexp/to_regexp.rb

@@ -0,0 +1,36 @@
+
+class Regexp
+
+  # Like #to_re, but following Ruby's formal definitions,
+  # only a Regular expression type object will respond to this.
+  #
+  # Note: To be of much real use this should be defined in core Ruby.
+  def to_regexp
+    self
+  end
+
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class TCRegexp < Test::Unit::TestCase
+
+    def test_to_regexp
+      r = /0..10/
+      assert_equal( r, r.to_regexp )
+    end
+
+  end
+
+=end
+

data/lib/facets/core/string.rb

@@ -0,0 +1,92 @@
+require 'facets/core/string/align_center'
+require 'facets/core/string/align_left'
+require 'facets/core/string/align_right'
+require 'facets/core/string/at'
+require 'facets/core/string/at_rand'
+require 'facets/core/string/basename'
+require 'facets/core/string/blank'
+require 'facets/core/string/bracket'
+require 'facets/core/string/brief'
+require 'facets/core/string/bytes'
+require 'facets/core/string/camelcase'
+require 'facets/core/string/camelize'
+require 'facets/core/string/capitalized'
+require 'facets/core/string/chars'
+require 'facets/core/string/cmp'
+require 'facets/core/string/demodulize'
+require 'facets/core/string/dequote'
+require 'facets/core/string/downcase'
+require 'facets/core/string/dresner'
+require 'facets/core/string/each_char'
+require 'facets/core/string/each_word'
+require 'facets/core/string/ends_with'
+require 'facets/core/string/first'
+require 'facets/core/string/first_char'
+require 'facets/core/string/fold'
+require 'facets/core/string/format'
+require 'facets/core/string/frequency'
+require 'facets/core/string/humanize'
+require 'facets/core/string/indent'
+require 'facets/core/string/index_all'
+require 'facets/core/string/last'
+require 'facets/core/string/last_char'
+require 'facets/core/string/line_wrap'
+require 'facets/core/string/lines'
+require 'facets/core/string/lowercase'
+require 'facets/core/string/margin'
+require 'facets/core/string/methodize'
+require 'facets/core/string/modulize'
+require 'facets/core/string/mscan'
+require 'facets/core/string/natcmp'
+require 'facets/core/string/nchar'
+require 'facets/core/string/ordinal'
+require 'facets/core/string/pathize'
+require 'facets/core/string/plural'
+require 'facets/core/string/pop'
+require 'facets/core/string/probability'
+require 'facets/core/string/pull'
+require 'facets/core/string/push'
+require 'facets/core/string/quote'
+require 'facets/core/string/rand_byte'
+require 'facets/core/string/rand_index'
+require 'facets/core/string/range'
+require 'facets/core/string/range_all'
+require 'facets/core/string/range_of_line'
+require 'facets/core/string/regesc'
+require 'facets/core/string/self/format'
+require 'facets/core/string/self/interpolate'
+require 'facets/core/string/self/patterns'
+require 'facets/core/string/self/rand_letter'
+require 'facets/core/string/self/random'
+require 'facets/core/string/shatter'
+require 'facets/core/string/shell_escape'
+require 'facets/core/string/shift'
+require 'facets/core/string/shuffle'
+require 'facets/core/string/similarity'
+require 'facets/core/string/singular'
+require 'facets/core/string/slap'
+require 'facets/core/string/soundex'
+require 'facets/core/string/starts_with'
+require 'facets/core/string/succ'
+require 'facets/core/string/tab'
+require 'facets/core/string/tabto'
+require 'facets/core/string/to_a'
+require 'facets/core/string/to_arr'
+require 'facets/core/string/to_b'
+require 'facets/core/string/to_const'
+require 'facets/core/string/to_date'
+require 'facets/core/string/to_proc'
+require 'facets/core/string/to_re'
+require 'facets/core/string/to_rx'
+require 'facets/core/string/to_time'
+require 'facets/core/string/unbracket'
+require 'facets/core/string/underscore'
+require 'facets/core/string/unix_crypt'
+require 'facets/core/string/unpack'
+require 'facets/core/string/unshift'
+require 'facets/core/string/upcase'
+require 'facets/core/string/uppercase'
+require 'facets/core/string/whitespace'
+require 'facets/core/string/word_filter'
+require 'facets/core/string/word_wrap'
+require 'facets/core/string/words'

data/lib/facets/core/string/align_center.rb

@@ -0,0 +1,87 @@
+
+class String
+
+  # Align a string to the right.
+  # The defualt alignment seperation is a new line ("/n")
+  # This can be changes as can be the padding string which
+  # defaults to a single space (' ').
+  def align_right( n, sep="\n", c=' ' )
+    return rjust(n.to_i,c.to_s) if sep==nil
+    q = split(sep.to_s).collect { |line|
+      line.rjust(n.to_i,c.to_s)
+    }
+    q.join(sep.to_s)
+  end
+
+  # Align a string to the left.
+  # The defualt alignment seperation is a new line ("/n")
+  # This can be changes as can be the padding string which
+  # defaults to a single space (' ').
+  def align_left( n, sep="\n", c=' ' )
+    return ljust(n.to_i,c.to_s) if sep==nil
+    q = split(sep.to_s).collect { |line|
+      line.ljust(n.to_i,c.to_s)
+    }
+    q.join(sep.to_s)
+  end
+
+  # Centers each line of a string.
+  #
+  #   s = <<-EOS
+  #   This is a test
+  #   and
+  #   so on
+  #   EOS
+  #   puts s.align_center(14)
+  #
+  # _produces_
+  #
+  #   This is a test
+  #        and
+  #       so on
+  #
+  # Align a string to the center.
+  # The defualt alignment seperation is a new line ("/n")
+  # This can be changed as can be the padding string which
+  # defaults to a single space (' ').
+  def align_center( n, sep="\n", c=' ' )
+    return center(n.to_i,c.to_s) if sep==nil
+    q = split(sep.to_s).collect { |line|
+      line.center(n.to_i,c.to_s)
+    }
+    q.join(sep.to_s)
+  end
+
+  # Deprecated alias for #align_center.
+  #alias_method :center_lines, :align_center
+
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class TCString < Test::Unit::TestCase
+
+    def test_align_right
+      assert_equal( "      xxx", "xxx".align_right(9) )
+    end
+
+    def test_align_left
+      assert_equal( "xxx      ", "xxx".align_left(9) )
+    end
+
+    def test_align_center
+      assert_equal( "   xxx   ", "xxx".align_center(9) )
+    end
+
+  end
+
+=end

data/lib/facets/core/string/align_left.rb

@@ -0,0 +1,2 @@
+# stub
+require 'facet/string/align_center'

data/lib/facets/core/string/align_right.rb

@@ -0,0 +1,2 @@
+# stub
+require 'facet/string/align_center'

data/lib/facets/core/string/at.rb

@@ -0,0 +1,8 @@
+
+class String
+
+  # Alias for slice which increases polymorphism
+  # with Array.
+  alias_method :at, :slice
+
+end

data/lib/facets/core/string/at_rand.rb

@@ -0,0 +1,65 @@
+
+require 'facet/array/at_rand'
+require 'facet/string/self/patterns'
+require 'facet/string/shatter'
+
+class String
+
+  # Return a random separation of the string.
+  # Default separation is by charaacter.
+  #
+  #   "Ruby rules".at_rand(' ')  #=> ["Ruby"]
+  #
+  def at_rand( separator=// )
+    separator = self.class.patterns( separator )
+    self.split(separator,-1).at_rand
+  end
+
+  # Return a random separation while removing it
+  # from the string. Default separation is by character.
+  #
+  #   s = "Ruby rules"
+  #   s = at_rand!(' ')  #=> "Ruby"
+  #   s                  #=> "rules"
+  #
+  def at_rand!( separator=// )
+    separator = self.class.patterns( separator )
+    a = self.shatter( separator )
+    w = []; a.each_with_index { |s,i| i % 2 == 0 ? w << s : w.last << s }
+    i = rand( w.size )
+    r = w.delete_at( i )
+    self.replace( w.join('') )
+    return r
+  end
+
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class TCString < Test::Unit::TestCase
+
+    def test_at_rand
+      a = '12345'
+      20.times{ assert_nothing_raised{ a.at_rand } }
+      20.times{ assert( a.include?( a.at_rand ) ) }
+    end
+
+    def test_at_rand!
+      x = 'ab'
+      r = x.at_rand!
+      assert( r == 'a' || r == 'b' )
+      assert( x == 'a' || x == 'b' )
+    end
+
+  end
+
+=end