facets 2.1.3 → 2.2.0

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

@@ -1,22 +1,10 @@
-# TITLE:
-#
-#   Crypt
-#
-# SUMMARY:
-#
-#   Adds a default salt to crypt.
-#
-# TODO:
-#
-#   - Deprecate once/if part of Ruby proper.
-
-#
 class String
 
   alias_method :_crypt, :crypt
 
   # Common Unix cryptography method.
-  #
+  # This adds a default salt to the built-in crypt method.
+
   def crypt(salt=nil)
     salt ||= (
       (rand(26) + (rand(2) == 0 ? 65 : 97) ).chr +
@@ -26,34 +14,9 @@ class String
   end
 
   # Common Unix cryptography in-place method.
-  #
+
   def crypt!(salt=nil)
     replace(crypt(salt))
   end
 
 end
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestStringCrypt < Test::Unit::TestCase
-
-    def test_crypt
-      assert_nothing_raised { "abc 123".crypt }
-    end
-
-    def test_crypt!
-      assert_nothing_raised { "abc 123".crypt! }
-    end
-
-  end
-
-=end

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

@@ -1,17 +1,3 @@
-# TITLE:
-#
-#   String Filter Extensions
-#
-# SUMMARY:
-#
-#   String extension methods which filter or rewrite a string.
-#
-# CREDIT:
-#
-#   - George Moschovitis
-#   - Thomas Sawyer
-
-#
 class String
 
   # Apply a set of rules (regular expression matches) to the string.
@@ -26,6 +12,8 @@ class String
   #
   # === Output:
   # The rewritten string.
+  #
+  #   CREDIT: George Moschovitis
 
   def rewrite(string, rules)
     return nil unless string
@@ -42,6 +30,8 @@ class String
   #
   #   "a string".word_filter { |word| word =~ /^a/ }  #=> "string"
   #
+  #   CREDIT: George Moschovitis
+
   def word_filter( &blk )
     s = self.dup
     s.word_filter!( &blk )
@@ -51,6 +41,8 @@ class String
   #
   #   "a string".word_filter { |word| ... }
   #
+  #   CREDIT: George Moschovitis
+
   def word_filter! #:yield:
     rest_of_string = self
     wordfind = /(\w+)/
@@ -64,39 +56,5 @@ class String
     end
     self
   end
-end
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestStringFilter < Test::Unit::TestCase
-
-    def test_regesc
-      a = "?"
-      b = /#{a.regesc}/
-      assert( b =~ "?" )
-    end
-
-    def test_word_filter
-      s = "this is a test"
-      n = s.word_filter{ |w| "#{w}1" }
-      assert_equal( 'this1 is1 a1 test1', n )
-    end
-
-    def test_word_filter!
-      s = "this is a test"
-      s.word_filter!{ |w| "#{w}1" }
-      assert_equal( 'this1 is1 a1 test1', s )
-    end
-
-  end
 
-=end
+end

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

@@ -1,20 +1,3 @@
-# TITLE:
-#
-#   String Formating Extensions
-#
-# SUMMARY:
-#
-#   String extension methods which formating including folding
-#   and word wrapping.
-#
-# CREDIT:
-#
-#   - George Moschovitis
-#   - Gavin Kistner
-#   - Dayne Broderson
-#   - Thomas Sawyer
-
-#
 class String
 
   # Returns short abstract of long strings (first 'count'
@@ -22,7 +5,8 @@ class String
   # force_cutoff: break forcibly at 'count' chars. Does not accept
   # count < 2
   #
-  #   CREDIT George Moschovitis
+  #   CREDIT: George Moschovitis
+
   def brief(count = 128, force_cutoff = false, ellipsis="...")
     return nil if count < 2
 
@@ -35,7 +19,11 @@ class String
     end
   end
 
+  # Cleave a string. Break a string in two parts at
+  # the nearest whitespace.
   #
+  #   CREDIT: Trans
+
   def cleave(threshold=nil, len=nil)
     l = (len || size / 2)
     t = threshold || size
@@ -74,11 +62,12 @@ class String
   #
   #   "This is a test.\n\nIt clumps lines of text. "
   #
-  #--
-  # One possible flaw with this that might could use a fix:
+  # One arguable flaw with this, that might need a fix:
   # if the given string ends in a newline, it is replaced with
   # a single space.
-  #++
+  #
+  #   CREDIT: Trans
+
   def fold(ignore_indented=false)
     ns = ''
     i = 0
@@ -107,15 +96,17 @@ class String
   #   12345
   #   67890
   #
-  def line_wrap(width)
-    s = gsub(/\t/,' '*4) # tabs default to 4 spaces.
+  #  CREDIT: Trans
+
+  def line_wrap(width, tabs=4)
+    s = gsub(/\t/,' ' * tabs) # tabs default to 4 spaces
     s = s.gsub(/\n/,' ')
     r = s.scan( /.{1,#{width}}/ )
     r.join("\n") << "\n"
   end
 
-  # ??? This is alternateive from glue: worth providing?
-
+  # TODO: This is alternateive from glue: worth providing?
+  #
   # Enforces a maximum width of a string inside an
   # html container. If the string exceeds this maximum width
   # the string gets wraped.
@@ -138,13 +129,9 @@ class String
   #
   # See the test cases to better understand the behaviour!
 
-  #   def self.wrap(string, width = 20, separator = " ")
-  #     return nil unless string
-  #
+  #   def wrap(width = 20, separator = " ")
   #     re = /([^#{separator}]{1,#{width}})/
-  #     wrapped_string = string.scan(re).join(separator)
-  #
-  #     return wrapped_string
+  #     scan(re).join(separator)
   #   end
 
   # Word wrap a string not exceeding max width.
@@ -157,14 +144,18 @@ class String
   #   is a
   #   test
   #
-  #   CREDIT Gavin Kistner
-  #   CREDIT Dayne Broderson
+  #   CREDIT: Gavin Kistner
+  #   CREDIT: Dayne Broderson
+
   def word_wrap( col_width=80 )
     self.dup.word_wrap!( col_width )
   end
 
   # As with #word_wrap, but modifies the string in place.
   #
+  #   CREDIT: Gavin Kistner
+  #   CREDIT: Dayne Broderson
+
   def word_wrap!( col_width=80 )
     self.gsub!( /(\S{#{col_width}})(?=\S)/, '\1 ' )
     self.gsub!( /(.{1,#{col_width}})(?:\s+|$)/, "\\1\n" )
@@ -186,96 +177,3 @@ class String
   #end
 
 end
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class String
-    include Format
-  end
-
-  class TestStringFormat < Test::Unit::TestCase
-
-    def test_fold_1
-      s = "This is\na test.\n\nIt clumps\nlines of text."
-      o = "This is a test.\n\nIt clumps lines of text."
-      assert_equal( o, s.fold )
-    end
-
-    def test_fold_2
-      s = "This is\na test.\n\n  This is pre.\n  Leave alone.\n\nIt clumps\nlines of text."
-      o = "This is a test.\n\n  This is pre.\n  Leave alone.\n\nIt clumps lines of text."
-      assert_equal( o, s.fold(true) )
-    end
-
-    def test_line_wrap
-      assert_equal "abc\n123\n", "abc123".line_wrap(3)
-      assert_equal "abcd\n123\n", "abcd123".line_wrap(4)
-    end
-
-    def test_word_wrap
-      assert_equal "abcde\n12345\nxyzwu\n", "abcde 12345 xyzwu".word_wrap(5)
-      assert_equal "abcd\n1234\nxyzw\n", "abcd 1234 xyzw".word_wrap(4)
-      assert_equal "abc\n123\n", "abc 123".word_wrap(4)
-      assert_equal "abc \n123\n", "abc  123".word_wrap(4)
-      assert_equal "abc \n123\n", "abc     123".word_wrap(4)
-    end
-
-    def test_word_wrap!
-      w = "abcde 12345 xyzwu" ; w.word_wrap!(5)
-      assert_equal("abcde\n12345\nxyzwu\n", w)
-      w = "abcd 1234 xyzw" ; w.word_wrap!(4)
-      assert_equal("abcd\n1234\nxyzw\n", w)
-      w = "abc 123" ; w.word_wrap!(4)
-      assert_equal "abc\n123\n", w
-      w = "abc  123" ; w.word_wrap!(4)
-      assert_equal("abc \n123\n", w)
-      w = "abc     123" ; w.word_wrap!(4)
-      assert_equal("abc \n123\n", w)
-    end
-
-    # def test_word_wrap
-    #   assert_equal "abcde-\n12345-\nxyzwu\n", "abcde12345xyzwu".word_wrap(6,2)
-    #   assert_equal "abcd-\n1234-\nxyzw\n", "abcd1234xyzw".word_wrap(5,2)
-    #   assert_equal "abc \n123\n", "abc 123".word_wrap(4,2)
-    #   assert_equal "abc \n123\n", "abc  123".word_wrap(4,2)
-    #   assert_equal "abc \n123\n", "abc     123".word_wrap(4,2)
-    # end
-
-     def test_cleave_nospaces
-       assert_equal [ 'whole', '' ], 'whole'.cleave
-       assert_equal [ 'Supercalifragilisticexpialidocious', '' ],
-                    'Supercalifragilisticexpialidocious'.cleave
-     end
-
-     def test_cleave_exact_middle
-       assert_equal [ 'fancy', 'split' ], 'fancy split'.cleave
-       assert_equal [ 'All good Rubyists', 'know how to party' ],
-                    'All good Rubyists know how to party'.cleave
-     end
-
-     def test_cleave_closer_to_start
-       assert_equal [ 'short', 'splitter' ], 'short splitter'.cleave
-       assert_equal [ 'Four score and', 'seven years ago...' ],
-                    'Four score and seven years ago...'.cleave
-       assert_equal [ 'abc def', 'ghijklm nop' ],
-                    'abc def ghijklm nop'.cleave
-     end
-
-     def test_cleave_closer_to_end
-       assert_equal [ 'extended', 'split' ], 'extended split'.cleave
-       assert_equal [ 'abc defghi', 'jklm nop' ],
-                    'abc defghi jklm nop'.cleave
-     end
-
-   end
-
-=end

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

@@ -1,35 +1,60 @@
-# TITLE:
-#
-#   String Indexable
-#
-# SUMMARY:
-#
-#   Includes the Indexable mixin into String.
-#
-#   String's Indexable methods are modified to also
-#   accept pattern matching.
-#
-# CREDIT:
-#
-#   - Thomas Sawyer
-#
-# TODO:
-#
-#   - The index_all method could probably be defined for Indexable in general too.
-
 require 'facets/string/splice'
 require 'facets/string/scan'
 require 'facets/indexable'
 
 class String
+
   include Indexable
 
+  # An extraneous feature, but make String more ploymorphic
+  # with Array.
+  #
+  #   "HELLO".at(2)  #=> "L"
+
+  def at(index)
+    case index
+    when Fixnum
+      self[index].chr
+    else
+      self[index]
+    end
+  end
+
+  # Like index but returns an array of all index locations.
+  # The reuse flag allows the trailing portion of a match to be
+  # reused for subsquent matches.
+  #
+  #   "abcabcabc".index_all('a')  #=> [0,3,6]
+  #
+  #   "bbb".index_all('bb', false)  #=> [0]
+  #   "bbb".index_all('bb', true)   #=> [0,1]
+  #
+  #   TODO: Culd probably be defined for Indexable in general too.
+
+  def index_all(s, reuse=false)
+    s = Regexp.new(Regexp.escape(s)) unless Regexp===s
+    ia = []; i = 0
+    while (i = index(s,i))
+      ia << i
+      i += (reuse ? 1 : $~[0].size)
+    end
+    ia
+  end
+
+  #Or should this be like #split? or self + '/' + other?
+  #alias /      []
+
+  #-----------------------------------------------------------------
+  # The following methods override Indexable to better suit String.
+  #-----------------------------------------------------------------
+
   # Returns the first separation of a string.
   # Default seperation is by character.
   #
   #   "Hello World".first       #=> "H"
   #   "Hello World".first(' ')  #=> "Hello"
   #
+
   def first(pattern=//)
     case pattern
     when Regexp, String
@@ -44,6 +69,7 @@ class String
   #
   #   "Hello World".last(' ')  #=> "World"
   #
+
   def last(pattern=//)
     case pattern
     when Regexp, String
@@ -70,6 +96,7 @@ class String
   #   a.first!(' ')  #=> "Hello"
   #   a              #=> "World"
   #
+
   def first!(pattern=//)
     case pattern
     when Regexp, String
@@ -101,6 +128,7 @@ class String
   #   a.last!(' ')  #=> "World"
   #   a             #=> "Hello"
   #
+
   def last!(pattern=//)
     case pattern
     when Regexp, String
@@ -115,11 +143,12 @@ class String
     end
   end
 
-  # TODO Should Strin#first= replace first char as in Indexable?
+  # TODO: Should Strin#first= replace first char as in Indexable?
 
   # Prepends to a string.
   #
   #   "Hello World".first = "Hello,"  #=> "Hello, Hello World"
+
   def first=(x)
     insert(0, x.to_s)
   end
@@ -128,121 +157,9 @@ class String
   #
   #   "Hello World".last = ", Bye."  #=>  "Hello World, Bye."
   #
+
   def last=(str)
     self << str
   end
 
-  # THE REMAINING METHODS ARE STRING SPECIFIC.
-
-  # Like index but returns an array of all index locations.
-  # The reuse flag allows the trailing portion of a match to be
-  # reused for subsquent matches.
-  #
-  #   "abcabcabc".index_all('a')  #=> [0,3,6]
-  #
-  #   "bbb".index_all('bb', false)  #=> [0]
-  #   "bbb".index_all('bb', true)   #=> [0,1]
-  #
-  def index_all(s, reuse=false)
-    s = Regexp.new(Regexp.escape(s)) unless Regexp===s
-    ia = []; i = 0
-    while (i = index(s,i))
-      ia << i
-      i += (reuse ? 1 : $~[0].size)
-    end
-    ia
-  end
-
-  # An extraneous feature, but make String more ploymorphic
-  # with Array.
-
-  def at(index)
-    case index
-    when Fixnum
-      self[index].chr
-    else
-      self[index]
-    end
-  end
-
-  #Or should this be like #split? or self + '/' + other?
-  #alias /      []
-
 end
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestStringIndexable < Test::Unit::TestCase
-
-    def test_first
-      assert_equal( "a", "abcxyz".first )
-      assert_equal( "ax", "ax by cz".first(' ') )
-      assert_equal( "a", "a\nb\nc".first("\n") )
-    end
-
-    def test_first_eq
-      s = "abc"
-      s.first = "123"
-      assert_equal( "123abc", s )
-      s = "a\nbc"
-      s.first = "123"
-      assert_equal( "123a\nbc", s )
-    end
-
-    def test_first!
-      s = "a\nbc"
-      s.first!("\n")
-      assert_equal( "bc", s )
-    end
-
-    def test_last
-      assert_equal( "z", "abcxyz".last )
-      assert_equal( "cz", "ax by cz".last(' ') )
-      assert_equal( "c", "a\nb\nc".last("\n") )
-    end
-
-    def test_last_eq
-      s = "abc"
-      s.last = "123"
-      assert_equal( "abc123", s )
-      s = "a\nbc"
-      s.last = "123"
-      assert_equal( "a\nbc123", s )
-    end
-
-    def test_last!
-      s = "abc"
-      s.last!
-      assert_equal( "ab", s )
-      s = "a b c"
-      s.last!(' ')
-      assert_equal( "a b", s )
-    end
-
-    def test_index_all
-      assert_equal( [0,4,8], "a123a567a9".index_all(/a/) )
-    end
-
-    def test_index_all_with_string
-      assert_equal( [0,4,8], "a123a567a9".index_all('a') )
-    end
-
-    def test_index_all_with_regexp_reuse
-      assert_equal( [0,4,8], "a123a567a9".index_all(/a/, true) )
-      assert_equal( [0], "bbb".index_all('bb', false) )
-      assert_equal( [0,1], "bbb".index_all('bb', true) )
-    end
-
-  end
-
-=end